> ## 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 a person
> Get all bank accounts for a person. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the person.
## OpenAPI
````json GET /api/v1/relations/persons/bankaccounts
{
"openapi": "3.0.4",
"info": {
"title": "Relations V1",
"description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Common"
},
{
"name": "CommunicationFormAPI"
},
{
"name": "EstateAgentAPI"
},
{
"name": "Metadata"
},
{
"name": "OrganisationAPI"
},
{
"name": "OwnerAPI"
},
{
"name": "PersonAPI"
},
{
"name": "RelationTypeAPI"
},
{
"name": "SupplierAPI"
},
{
"name": "SupplierTypeAPI"
}
],
"paths": {
"/api/v1/relations/persons/bankaccounts": {
"get": {
"tags": [
"Relations"
],
"summary": "Get all bank accounts for a person",
"description": "Get all bank accounts for a person. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the person.",
"operationId": "GetPersonBankAccounts",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BankAccount"
}
}
}
}
},
"404": {
"description": "The requested person was not found."
}
},
"x-d360-narrative-url": "Get All Bank Accounts for a Person
Retrieves all bank accounts currently linked to a specific person.
A developer calls this endpoint to view the bank account details for a person, verify a specific account, or compare against existing records before adding, updating, or removing one.
The person 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 person 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 person 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 person's preferred bank account, used as the default when multiple accounts are on file (for example for outgoing payments). A person 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. |