Documentation Index

Fetch the complete documentation index at: https://www.bloxs.io/llms.txt

Use this file to discover all available pages before exploring further.

Get all bank accounts for an estate agent

Prev Next
Get
/api/v1/relations/estateAgents/bankaccounts

Get all bank accounts for an estate agent. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the estate agent.

Get All Bank Accounts for an EstateAgent

Retrieves all bank accounts currently linked to a specific estate agent.

A developer calls this endpoint to view the bank account details for an estate agent, verify a specific account, or compare against existing records before adding, updating, or removing one.

The estate agent is located via reference or externalIdentifier, at least one of which must be supplied.


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 estate agent whose bank accounts should be retrieved.

externalIdentifier

string

Required (at least one of reference or externalIdentifier must be given)

The external API identifier of the estate agent whose bank accounts should be retrieved.


Response Fields

Field

Type

Required

Description

bankAccountNumber

string, max 34

Required

The bank account number, typically an IBAN. The 34-character maximum accommodates the longest IBAN formats. This is the only identifier per account; there is no separate account ID.

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 is the estate agent's preferred bank account, used as the default when multiple accounts are on file. An estate agent can have no bank accounts, or one or more. If one or more accounts exist, exactly one of them will have this value set to true.

Security
Query parameters
reference
string

The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

externalIdentifier
string

The external API identifier of the model.

Responses
200

OK

Array of object
object
bankAccountNumber
string
Min length0
Max length34
bic
string
Min length0
Max length11
isBankAccountNonIBAN
boolean
isPreferredBankAccount
boolean
404

The requested estate agent was not found.