API reference
  1. Counterparties
  2. External accounts

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

The type of the external account.

Allowed:
string

The name of the external account.

string
required

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

holder_name_details
object | null

The structured name of an individual account holder, for payment rails that identify a person by first and last name. Both names are required when the object is sent.

string
enum

Whether the account holder is an individual or a legal entity.

Allowed:
string
enum

The kind of instrument the account is. A wallet is identified by its wallet object instead of an account_number and a bank_code.

Allowed:
wallet
object

The wallet the account is. Required when instrument_type is wallet, not allowed otherwise.

string

The account number. Required when instrument_type is bank_account or not set, must be omitted otherwise.

string
enum

The format of the account number. Only allowed when instrument_type is bank_account or not set, must be omitted otherwise. When set, it must match account_number unless the format is other or tokenized.

Allowed:
string

The bank code, for instance BIC / Swift code, UK sort code, or US routing number. Required when instrument_type is bank_account or not set, must be omitted otherwise.

string
enum

The format of the bank code. Only allowed when instrument_type is bank_account or not set, must be omitted otherwise. When set, it must match bank_code unless the format is other or tokenized.

Allowed:
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.

string

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

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.

string

The name of the bank holding the account. Only allowed when instrument_type is bank_account or not set, must be omitted otherwise.

bank_address
object

The address of the bank holding the account. Only allowed when instrument_type is bank_account or not set, must be omitted otherwise.

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

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?