Verification
The Verify API provides an instant and seamless way to verify bank accounts. Orum verifies accounts by pushing an instant micro deposit to the account in question. We are currently able to confirm if the account is open and valid, as well as ownership, and we push that information back to you via webhook.
Verification Status
Status of account verification.
Verification Status | Description |
---|---|
pending | Acknowledgment of the request being received |
valid | A bank account is open and valid |
closed | A bank account is closed |
invalid | The bank account information provided is invalid |
failed | The verification request has failed |
Status Reasons
Possible status reason codes for failed, invalid, and closed accounts.
Status Reason | Description |
---|---|
blocked_account | An account in the transfer request was blocked or prohibits posting of transfers against it |
closed_account | Account number specified has been closed on the bank of account's books |
deceased_party | One of the parties in the transfer request was deceased |
duplicated_transfer | Duplicate of a previous transfer request |
invalid_account | The account number provided is invalid or does not exist |
invalid_field | There was erroneous, invalid, or missing data in the transfer request |
invalid_routing | The routing number provided is invalid or does not exist |
regulatory_error | The transfer could not be completed because of limitations imposed by a regulator |
unavailable_financial_institution | Sending or receiving financial institution is currently not available or does not support this request type |
unexpected_error | There was an unexpected error with this transfer request |
unsupported_transfer | Transfer type is not supported or forbidden |
Verify Webhooks
Verify webhooks are configured using the same momentum endpoints. For event_types the webhook configuration can either use subscribe_all
or specifically use verify_account_updated
for verify webhook events.
Sample Webhook Event
{
"event_id": "36fa9e91-b63d-4cc4-9055-eab98198a7ea",
"event_type": "verify_account_updated",
"created_at": "2023-06-01T15:00:09.374Z",
"event_data": {
"account": {
"id": "2b610cd7-0366-47a0-94c7-923dc0472bc5",
"account_number": "12345678910",
"routing_number": "102001017",
"account_holder_name": "John Doe",
"verification_status": "pending",
"estimated_verification_date": "2023-07-26T00:00:00Z",
"created_at": "2023-06-01T14:59:46.751044Z",
"updated_at": "2023-06-01T15:00:05.250318Z"
}
}
}
Verify Sandbox Environment
The sandbox environment is also available to verify APIs.
In the sandbox, all verify accounts you create will have a verification_status of "pending" in the POST response and will then move to a verification_status of "valid".
To simulate non-valid verification_statuses, pass the status you want to simulate in the account_holder_name field along with all other required fields. You will receive a webhook when the account's status updates from "pending" to the simulated status.
NOTE: Only "failed" and "invalid" non-valid verifications statuses are supported in sandbox.
Updated about 8 hours ago