Get Verify Account

GET

verify

accounts

{id}

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

{
  "account": {
    "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>",
      "phone_number": "<string>",
      "first_name_match": "match",
      "last_name_match": "match",
      "phone_number_match": "match",
      "ssn_match": "match"
    },
    "business": {
      "business_name": "<string>",
      "phone_number": "<string>",
      "business_name_match": "match",
      "phone_number_match": "match",
      "tax_id_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

Path Parameters

string

required

Orum generated unique id for the account you are fetching.

Response

200

application/json

200 response.

account

object

required

account.id

string

required

Orum generated unique id for the resource.

account.created_at

string

required

Timestamp when the resource was created.

account.updated_at

string

required

Timestamp when the resource was last updated.

account.account_number

string

required

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

account.routing_number

string

required

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

account.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

account.verification_status

enum<string>

required

Status of account verification.

Available options:

pending,

valid,

closed,

invalid,

failed

account.email

string

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

account.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

account.ownership_status

enum<string>

Status of account ownership.

Available options:

pending,

full,

partial,

not_a_match,

not_found

account.person

object

Ownership details for a person

account.business

object

Ownership details for a business

account.control_status

enum<string>

Status of account control.

Available options:

pending,

valid,

canceled

account.debit_status

enum<string>

Status of account debit.

Available options:

pending,

valid,

blocked,

failed

account.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

account.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"

account.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

Get All Verify Accounts Verify Account Control

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

{
  "account": {
    "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>",
      "phone_number": "<string>",
      "first_name_match": "match",
      "last_name_match": "match",
      "phone_number_match": "match",
      "ssn_match": "match"
    },
    "business": {
      "business_name": "<string>",
      "phone_number": "<string>",
      "business_name_match": "match",
      "phone_number_match": "match",
      "tax_id_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

Path Parameters

Response