Skip to main content
POST
Verify and tokenize a bank account (ACH / RTP)

Authorizations

Authorization
string
header
required

HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.

Body

application/json

Provide either customer_account_token or the raw account fields (account, routing_number, recipient_first_name, recipient_last_name, recipient_address1, recipient_city, recipient_state, recipient_zip) — never both.

participant_id
integer
required

Unique participant identifier assigned by Ingo.

Example:

12345

account_type
enum<string>
required

Value should be set to AC for Standard ACH / RTP or SD for Same-Day ACH.

Available options:
AC,
SD
Minimum string length: 1
Example:

"AC"

version
integer
required

API version of the request. Current version is 11.

Example:

11

timestamp
integer<int64>
required

Unix timestamp of the request.

Example:

1576100326

participant_unique_id1
string
required

Participant assigned ID to be associated with customer_account_token creation. Should correlate to participant assigned values affiliated with future process requests for tracking purposes (e.g. CustomerID or AccountID). Must not contain NPI data.

Required string length: 1 - 255
Example:

"5bf1e2c3-2169-406f-bf1b-f7bc5c2303b3"

account
string

Bank account number. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255
Example:

"22222222"

routing_number
string

Bank routing number associated with the account number. Required unless a valid customer_account_token is provided.

Example:

"011000015"

customer_account_token
string

Alternative to raw account data when the account was previously tokenized. If provided, the following fields are not required and should be omitted: recipient_first_name, recipient_last_name, account, routing_number, recipient_address1, recipient_city, recipient_state, recipient_zip.

Required string length: 1 - 255
Example:

"89421718-a62e-4344-8a1d-4baf73fb11f1"

recipient_zip
string

Recipient zip code. 5-digit zip or zip+4 in xxxxx-xxxx format. Required unless a valid customer_account_token is provided.

Maximum string length: 10
Pattern: ^[0-9]{5}(?:-[0-9]{4})?$
Example:

"30313"

recipient_first_name
string

Recipient first name. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255
Example:

"Luke"

recipient_last_name
string

Recipient last name. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255
Example:

"Skywalker"

recipient_state
string

Recipient state (standard US postal abbreviation). Required unless a valid customer_account_token is provided.

Required string length: 2
Pattern: ^(?:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$
Example:

"GA"

recipient_city
string

Recipient city. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255
Example:

"Atlanta"

recipient_address1
string

Recipient address line 1. Required unless a valid customer_account_token is provided.

Required string length: 1 - 255
Example:

"123 Main St."

fi_account_type
string

Financial institution account type. Default = 1 (DDA/Checking). 1 = DDA/Checking, 2 = Savings.

Maximum string length: 3
Pattern: ^(1|2)?$
Example:

"1"

fi_account_classification
string

Financial institution account classification. Default = 1 (Personal). 1 = Personal, 2 = Business.

Maximum string length: 3
Pattern: ^(1|2)?$
Example:

"1"

amount
number<float> | null

Dollar amount of disbursement. Max value determined by participant velocity limits.

Required range: x >= 0.01
Example:

1010.5

recipient_phone
integer | null

10-digit recipient phone number.

Example:

1231231234

recipient_address2
string | null

Recipient address line 2.

Maximum string length: 255
Example:

"Apt 2"

recipient_business_name
string | null

Optional recipient business name.

Maximum string length: 150
Example:

"Skywalker Enterprises"

participant_unique_id2
string

Optional second participant assigned ID to be associated with customer_account_token creation. Should be carried forward to future process requests for tracking purposes. Must not contain NPI data.

Maximum string length: 255
Example:

"80525360-dae4-4d0f-9f5c-e09f3fdcf7c8"

store_id
string

Client assigned store ID. Required for Retail client participants.

Maximum string length: 255
Example:

"STORE-001"

clerk_id
string

Client assigned clerk ID. Required for Retail client participants.

Maximum string length: 255
Example:

"CLK-007"

terminal_id
string

Client assigned terminal ID. Required for Retail client participants.

Maximum string length: 255
Example:

"TERM-042"

Response

Verification successful — token returned

status
integer

Numeric code describing the status of the API request. 100 = Success.

Example:

100

client_message
string

Text description associated with the status code.

Example:

"Success"

data
object
time
string

Time in seconds to complete the request.

Example:

"1.0263"