Add a new bank account to a person.
Add a Bank Account to a Person
Adds a new bank account to an existing person's record.
A developer calls this endpoint to register a bank account for a person, for example when creating a new tenant and lease.
The person to add the bank account to is located via reference or externalIdentifier, at least one of which must be supplied.
A person can have at most one preferred bank account at any time: if the new account is added with isPreferredBankAccount set to true, the person's current preferred bank account is automatically set to false. If the person currently has no bank accounts at all, the new account is always forced to be preferred, regardless of the value sent, since a person must have exactly one preferred account whenever one or more accounts exist.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the person to add the bank account to. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the person to add the bank account to. |
bankAccountNumber | string, max 34 | Required | The bank account number to add, typically an IBAN. The 34-character maximum accommodates the longest IBAN formats. Must not already exist for this person; adding a duplicate is rejected with the error "The same bank account cannot be added more than once." |
bic | string, max 11 | Required | The Bank Identifier Code (BIC/SWIFT code) of the account's bank. |
isBankAccountNonIBAN | boolean | Optional | Indicates whether bankAccountNumber is a non-IBAN account number rather than a standard IBAN, relevant for accounts outside the SEPA area. |
isPreferredBankAccount | boolean | Optional | Indicates whether this new account should be set as the person's preferred bank account. If set to true, the person's current preferred bank account (if any) is automatically set to false. If this is the person's first bank account, it is always forced to preferred regardless of the value sent, since a person must have exactly one preferred account whenever any exist. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
bankAccountNumber | string, max 34 | Required | The bank account number that was added. |
bic | string, max 11 | Required | The Bank Identifier Code (BIC/SWIFT code) of the account's bank. |
isBankAccountNonIBAN | boolean | Optional | Indicates whether bankAccountNumber is a non-IBAN account number rather than a standard IBAN. |
isPreferredBankAccount | boolean | Optional | Indicates whether this account is now the person's preferred bank account. Always true if this was the person's first bank account. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
The bank account was added to the person
The bank account data has validation issues