Create an external account

Create a new external account with status=Verified. See externalAccount object definition for parameter details.

🚧Warning

Requires integration with an external IAV provider (e.g., Plaid) and must be enabled for your program.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
62001At most 0 external account(s) may be added.
62002Invalid Type: ''{request.type}''. Refer to API documentation for valid types.
62003Tag {request.tag} is already associated with another external account.
62004External account archival limit reached for today.
62005Either FirstName or LastName must be provided, preferably both.
62006Routing number is a required field.
62007Account number is a required field.
62008Account number invalid, please refer to API documentation for valid characters
62009Account number must be no more than 17 digits in length.
69203Routing number is a required field.
62013BusinessName is a required field for account type {request.type}
62014External Account creation is not enabled
62011FirstName is a required field for account type {request.type}.
62012LastName is a required field for account type {request.type}.
62618requestingCustomerId '{request.requestingCustomerId}' does not have permission to manage external accounts for customerId '{request.customerId}'
Body Params
int32
required
≥ 1
string
required
length ≤ 50
string
required
length ≤ 17
string
required
length ≤ 50
string
required
length ≤ 50
string
length ≤ 100
string
enum
required
Allowed:
string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
string
length ≤ 50
int32
≥ 1

The Helix-assigned unique ID for the individual customer requesting to create the external account. Only used when an individual is creating an external account on behalf of a business.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json