# ezyshield

## Docs

- [Download a regenerated ABA file](https://docs.ezyshield.com.au/api-reference/aba-checks/download-a-regenerated-aba-file.md): The file will contain only entries matched to verifications. When the original file has a balancing debit record, its amount will be updated to the sum of the matched entries.
- [Get an ABA check](https://docs.ezyshield.com.au/api-reference/aba-checks/get-an-aba-check.md): Requires the `aba_check:read` ability.
- [List all ABA checks](https://docs.ezyshield.com.au/api-reference/aba-checks/list-all-aba-checks.md): Requires the `aba_check:read` ability.
- [Upload a single ABA file](https://docs.ezyshield.com.au/api-reference/aba-checks/upload-a-single-aba-file.md): The ABA check will be created and the entries will be matched to verifications.
- [Create an API key](https://docs.ezyshield.com.au/api-reference/api-keys/create-an-api-key.md): The plain text token is only returned once and should be stored securely.
- [Delete an API key](https://docs.ezyshield.com.au/api-reference/api-keys/delete-an-api-key.md): Requires the `api_key:write` ability.
- [Get an API key](https://docs.ezyshield.com.au/api-reference/api-keys/get-an-api-key.md): Requires the `api_key:read` ability.
- [List all API keys](https://docs.ezyshield.com.au/api-reference/api-keys/list-all-api-keys.md): Requires the `api_key:read` ability.
- [Update an API key](https://docs.ezyshield.com.au/api-reference/api-keys/update-an-api-key.md): Requires the `api_key:write` ability.
- [Authentication](https://docs.ezyshield.com.au/api-reference/authentication.md): Authenticate API requests with organization-scoped API keys.
- [Check a verification](https://docs.ezyshield.com.au/api-reference/checks/check-a-verification.md): Requires the `check:write` ability.
- [Get a check for a verification](https://docs.ezyshield.com.au/api-reference/checks/get-a-check-for-a-verification.md): Requires the `check:read` ability.
- [List all checks for a verification](https://docs.ezyshield.com.au/api-reference/checks/list-all-checks-for-a-verification.md): Requires the `check:read` ability.
- [Errors](https://docs.ezyshield.com.au/api-reference/errors.md): Common API error responses and how to handle them.
- [Filtering and sorting](https://docs.ezyshield.com.au/api-reference/filtering-and-sorting.md): Use endpoint-supported filters and sorts on list responses.
- [Get the current organization](https://docs.ezyshield.com.au/api-reference/organizations/get-the-current-organization.md)
- [Reset the current sandbox organization](https://docs.ezyshield.com.au/api-reference/organizations/reset-the-current-sandbox-organization.md): Deletes sandbox account data and revokes every API key for the organization, including the key used for this request. Clears WorkOS invitations and memberships, disconnects accounting providers where supported, and preserves local users and billing usage. Requires the `verification:write` ability.
- [Pagination](https://docs.ezyshield.com.au/api-reference/pagination.md): Learn how to navigate through paginated API responses.
- [Rate limits](https://docs.ezyshield.com.au/api-reference/rate-limiting.md): API rate limits and response headers.
- [Sandbox](https://docs.ezyshield.com.au/api-reference/sandbox.md): Use the sandbox environment to test ezyshield integrations before production.
- [Using the API](https://docs.ezyshield.com.au/api-reference/using-the-api.md): Base URL, headers, authentication, pagination, filtering, and errors.
- [Cancel a verification](https://docs.ezyshield.com.au/api-reference/verifications/cancel-a-verification.md): Requires the `verification:write` ability.
- [Create a verification](https://docs.ezyshield.com.au/api-reference/verifications/create-a-verification.md): Requires the `verification:write` ability.
- [Get a verification](https://docs.ezyshield.com.au/api-reference/verifications/get-a-verification.md): Requires the `verification:read` ability.
- [List all verifications](https://docs.ezyshield.com.au/api-reference/verifications/list-all-verifications.md): Requires the `verification:read` ability.
- [Get a webhook event](https://docs.ezyshield.com.au/api-reference/webhook-events/get-a-webhook-event.md): Requires the `webhook_event:read` ability.
- [List all webhook events for a subscription](https://docs.ezyshield.com.au/api-reference/webhook-events/list-all-webhook-events-for-a-subscription.md): Requires the `webhook_event:read` ability.
- [Create a webhook subscription](https://docs.ezyshield.com.au/api-reference/webhook-subscriptions/create-a-webhook-subscription.md): Requires the `webhook_subscription:write` ability.
- [Delete a webhook subscription](https://docs.ezyshield.com.au/api-reference/webhook-subscriptions/delete-a-webhook-subscription.md): Requires the `webhook_subscription:write` ability.
- [Enable a disabled webhook subscription](https://docs.ezyshield.com.au/api-reference/webhook-subscriptions/enable-a-disabled-webhook-subscription.md): Resets the consecutive failure count and re-enables the subscription.
- [Get a webhook subscription](https://docs.ezyshield.com.au/api-reference/webhook-subscriptions/get-a-webhook-subscription.md): Requires the `webhook_subscription:read` ability.
- [List all webhook subscriptions](https://docs.ezyshield.com.au/api-reference/webhook-subscriptions/list-all-webhook-subscriptions.md): Requires the `webhook_subscription:read` ability.
- [Update a webhook subscription](https://docs.ezyshield.com.au/api-reference/webhook-subscriptions/update-a-webhook-subscription.md): Requires the `webhook_subscription:write` ability.
- [Changelog](https://docs.ezyshield.com.au/changelog.md): See the latest ezyshield updates, improvements, and platform changes.
- [ABA file checks](https://docs.ezyshield.com.au/guides/aba-file-checks.md): Upload ABA files to compare payment entries against existing verifications before processing the file elsewhere.
- [Run checks before payment](https://docs.ezyshield.com.au/guides/checks-before-payment.md): Use checks to compare current payment details against a successful verification before money moves.
- [Choose a confirmation mode](https://docs.ezyshield.com.au/guides/confirmation-modes.md): Decide whether a verification should use KYC, biometric confirmation, or skip contact confirmation.
- [Biometric verification](https://docs.ezyshield.com.au/guides/confirmation-modes/biometric.md): Use biometric verification when your system already has a suitable identity portrait for the contact.
- [KYC verification](https://docs.ezyshield.com.au/guides/confirmation-modes/kyc.md): Use KYC when ezyshield should establish the contact's identity during verification.
- [Skip contact confirmation](https://docs.ezyshield.com.au/guides/confirmation-modes/skip.md): Use skip mode only when contact identity assurance is handled outside ezyshield.
- [Contact verification flow](https://docs.ezyshield.com.au/guides/contact-verification-flow.md): What happens when a contact is asked to complete identity verification.
- [Create your first verification](https://docs.ezyshield.com.au/guides/first-verification.md): Create an API key, confirm your organization, create a verification, and receive the completion outcome.
- [Go live](https://docs.ezyshield.com.au/guides/go-live.md): Production checks before using ezyshield with real payees and payment workflows.
- [Linked verifications with attribution_id](https://docs.ezyshield.com.au/guides/linked-verifications.md): Use attribution_id to connect repeat verifications to the same record in your system.
- [Test your integration](https://docs.ezyshield.com.au/guides/test-your-integration.md): Use the sandbox environment environments, test BSBs, and webhook tooling before going live.
- [Receive completion events](https://docs.ezyshield.com.au/guides/webhooks.md): Update your system when a verification changes state.
- [Introduction](https://docs.ezyshield.com.au/index.md): Verify payees, receive outcomes, and check payment details before money moves.
- [ABA check](https://docs.ezyshield.com.au/objects/aba-check.md): A file-level check that compares ABA payment entries against existing verifications.
- [Check](https://docs.ezyshield.com.au/objects/check.md): A later comparison of current payment details against a verification fingerprint.
- [Organization](https://docs.ezyshield.com.au/objects/organization.md): The tenant boundary for API keys, verifications, checks, webhooks, and ABA file checks.
- [How ezyshield works](https://docs.ezyshield.com.au/objects/overview.md): Organizations, verifications, checks, webhooks, and ABA checks.
- [Verification](https://docs.ezyshield.com.au/objects/verification.md): A point-in-time record of business identity, contact identity, and bank account details.
- [Webhooks](https://docs.ezyshield.com.au/objects/webhooks.md): Webhook subscriptions and events for receiving ezyshield updates.
- [Test bank accounts](https://docs.ezyshield.com.au/testing/test-bank-accounts.md): BSB codes to simulate bank confirmation outcomes in the sandbox environment.

## OpenAPI Specs

- [api](https://docs.ezyshield.com.au/api-reference/api.json)