v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Client Account Creation Endpoints

account/client-accounts/individual

Use this endpoint to create a new individual client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers.

post/account/client-accounts/individual

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Statusstring

The status of the newly created client account.

ClientAccountIDstring

This ID should be saved as it is required in order to perform other actions using the client account such as creating new transactions.

VerifcationLinkstring

A link to verify the newly created client account if applicable.

Example response

{
  "Status": "ClientAccount1",
  "ClientAccountID": "ClientAccount1",
  "VerifcationLink": "ClientAccount1"
}