POST
/
verify
/
accounts
Post verify accounts
curl --request POST \
  --url https://api-sandbox.orum.io/verify/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "type": "status",
  "account_number": "00101044595",
  "routing_number": "021000021",
  "account_holder_name": "John Doe",
  "email": "[email protected]",
  "person": {
    "first_name": "John",
    "last_name": "Doe",
    "ssn": "123121234",
    "phone_number": "+11234567890"
  },
  "business": {
    "business_name": "Acme",
    "tax_id": "123456789",
    "phone_number": "+11234567890"
  },
  "sender_name": "Acme"
}'
{
  "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 and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
​
account_number
string
required

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

Example:

"00101044595"

​
routing_number
string
required

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

Example:

"021000021"

​
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
Example:

"John Doe"

​
type
enum<string>

The type of verify request to make. If not provided, we will default to "status".

Available options:
status,
control,
status_ownership,
control_ownership
​
email
string<email>

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

​
person
object

Ownership details for a person

Example:
{
  "first_name": "John",
  "last_name": "Doe",
  "ssn": "123121234",
  "phone_number": "+11234567890"
}
​
business
object

Ownership details for a business

Example:
{
  "business_name": "Acme",
  "tax_id": "123456789",
  "phone_number": "+11234567890"
}
​
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
Example:

"Acme"

Response

200 response.

​
account
object
required