Create external account

post

https://sandbox.numeral.io/v1/external_accounts

Create an external account, which relates to an existing active account holder.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

The type of the external account.

Allowed:

name

string

The name of the external account.

holder_name

string

required

The name of the legal entity or individual holding the account.

account_number

string

required

The account number.

account_number_format

string

enum

The format of the account number. When set, it must match account_number unless the format is other or tokenized.

Allowed:

bank_code

string

required

The bank code, for instance BIC / Swift code, UK sort code, or US routing number.

bank_code_format

string

enum

The format of the bank code. When set, it must match bank_code unless the format is other or tokenized.

Allowed:

account_holder_id

string

The ID of the related account holder. It must not be disabled.

organization_identification

object

The organization identification of the external account. See more here.

company_registration_number

string

The company registration number of the external account, when type = legal_entity.

company_registration_number_type

string

enum

The type of the external account's company registration number, when type = legal_entity.

Allowed:

holder_address

object

The address of the account holder, as an address object.

accept_duplicate_account_number

boolean

Defaults to false

Controls whether duplicate account detection includes the account holder's name as part of the uniqueness check.

If false (default), the API will return an error if an active external_account already exists with the same account_number and bank_code.
If true, the error is only triggered when an active external_account matches on account_number, bank_code, and holder_name, allowing duplicate account numbers across different holders.

metadata

object

Additional client data in JSON format. See Metadata.

custom_fields

object

Custom fields in JSON key:value format. See Custom fields.

Responses

200200

400Validation Error.

409Conflict.

415Unsupported Media Type.