Get All Verify Accounts

GET

verify

accounts

curl --request GET \
  --url https://api-sandbox.orum.io/verify/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "accounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "account_number": "<string>",
      "routing_number": "<string>",
      "account_holder_name": "<string>",
      "email": "[email protected]",
      "verification_status": "pending",
      "status_reason": "blocked_account",
      "ownership_status": "pending",
      "person": {
        "first_name": "<string>",
        "last_name": "<string>",
        "first_name_match": "match",
        "last_name_match": "match"
      },
      "control_status": "pending",
      "debit_status": "pending",
      "debit_status_reason": "blocked_account",
      "estimated_verification_date": "2023-07-13T00:00:00.000Z",
      "sender_name": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version

enum<string>

required

Version of Deliver API. Use v2022-09-21.

Available options:

v2022-09-21

Query Parameters

index

integer

default:0

Index for paginated results

Required range: x >= 0

size

integer

default:100

Max number of results to return

Required range: 0 <= x <= 500

string

Filter results by the account id

start_time

string

Filter results created at or after this time

end_time

string

Filter results created before this time

account_number

string

Filter results by account number

verification_status

enum<string>[]

Filter results by account status

Status of account verification.

Available options:

pending,

valid,

closed,

invalid,

failed

ownership_status

enum<string>[]

Filter results by account ownership status

Status of account ownership.

Available options:

pending,

full,

partial,

not_a_match,

not_found

control_status

enum<string>[]

Filter results by account control status

Status of account control.

Available options:

pending,

valid,

canceled

debit_status

enum<string>[]

Filter results by account debit status

Status of account debit.

Available options:

pending,

valid,

blocked,

failed

Response

200

application/json

200 response.

accounts

object[]

required

An array of verify accounts.

accounts.id

string

required

Orum generated unique id for the resource.

accounts.created_at

string

required

Timestamp when the resource was created.

accounts.updated_at

string

required

Timestamp when the resource was last updated.

accounts.account_number

string

required

Account number for US bank account. 4 to 17 digits are acceptable.

accounts.routing_number

string

required

9-digit American Bankers Association (ABA) routing number.

accounts.account_holder_name

string

required

Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

accounts.verification_status

enum<string>

required

Status of account verification.

Available options:

pending,

valid,

closed,

invalid,

failed

accounts.email

string

Email address to notify once the statement code is sent to the account to verify account control.

accounts.status_reason

enum<string>

Status reason for failed, invalid, and closed accounts.

Available options:

blocked_account,

closed_account,

deceased_party,

duplicated_transfer,

invalid_account,

invalid_field,

invalid_routing,

regulatory_error,

unavailable_financial_institution,

unexpected_error,

unsupported_transfer

accounts.ownership_status

enum<string>

Status of account ownership.

Available options:

pending,

full,

partial,

not_a_match,

not_found

accounts.person

object

Ownership details for a person

accounts.control_status

enum<string>

Status of account control.

Available options:

pending,

valid,

canceled

accounts.debit_status

enum<string>

Status of account debit.

Available options:

pending,

valid,

blocked,

failed

accounts.debit_status_reason

enum<string>

Status reason for failed and blocked accounts.

Available options:

blocked_account,

closed_account,

deceased_party,

duplicated_transfer,

invalid_account,

invalid_field,

invalid_routing,

regulatory_error,

unavailable_financial_institution,

unexpected_error,

unsupported_transfer,

debit_blocked,

unauthorized_transfer

accounts.estimated_verification_date

string

Estimated date that the account verification will be complete. Time will always be midnight and should be ignored.

Example:

"2023-07-13T00:00:00.000Z"

accounts.sender_name

string

Name of sender initiating the verification request. This name will appear on the statement and should be recognizable to the account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

Was this page helpful?

Post Verify Accounts Get Verify Account

curl --request GET \
  --url https://api-sandbox.orum.io/verify/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "accounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "account_number": "<string>",
      "routing_number": "<string>",
      "account_holder_name": "<string>",
      "email": "[email protected]",
      "verification_status": "pending",
      "status_reason": "blocked_account",
      "ownership_status": "pending",
      "person": {
        "first_name": "<string>",
        "last_name": "<string>",
        "first_name_match": "match",
        "last_name_match": "match"
      },
      "control_status": "pending",
      "debit_status": "pending",
      "debit_status_reason": "blocked_account",
      "estimated_verification_date": "2023-07-13T00:00:00.000Z",
      "sender_name": "<string>"
    }
  ]
}

Auth API

Deliver API

Verify API

Webhooks API

Authorizations

Headers

Query Parameters

Response