Sign in
Person accounts

Index accounts for a person

Returns an array containing all accounts owned by the person specified in the request URL.

get/v1/persons/{person_id}/accounts

Path parameters

person_idstring required

Query parameters

page[number]string

The number of results pages to return.

page[size]string

The size of each results page to return.

filter[iban]string

Filters the results by IBAN.

filter[status]string

Filters the results by account status.

Response

The operation was successful.

idstring

The ID of the account.

ibanstring

The account's IBAN.

bicstring

The account's BIC.

type'BASIC_ACCOUNT' | 'BILLING_ACCOUNT' | 'CALL_MONEY' | 'CASH_DEPOSIT' | 'CHECKING_BUSINESS' | 'CHECKING_BUSINESS_CREDITLINE' | 'CHECKING_FIXED_MATURITY' | 'CHECKING_OVERDRAFT' | 'CHECKING_OVERDRAFT_FLEXIBLE' | 'CHECKING_PERSON_CREDIT_LINE' | 'CHECKING_PERSON_INSTALMENT_LOAN' | 'CHECKING_PERSONAL' | 'CHECKING_PERSONAL_OVERDRAFT' | 'CHECKING_SOLE_PROPRIETOR' | 'CLEARING_ACCOUNT' | 'COLLECTION_ACCOUNT' | 'DECOUPLED_CARD_BUSINESS' | 'DEPOSIT_FIXED_TERM_BUSINESS' | 'DEPOSIT_TIME_PASSIVE' | 'EMONEY_PARKING' | 'EMONEY_PREPAID' | 'EMONEY_PREPAID_POOLING' | 'ESCROW_LIABILITY' | 'EXTERNAL_ACCOUNT' | 'FACTORING' | 'GENERAL_LEDGER' | 'GUARANTEE' | 'INDIVIDUAL_SPECIFIC_PROVISIONS' | 'LIABILITY_ASSUMPTION' | 'LOAN_ACCOUNT_CREDIT_LINE' | 'LOAN_ACCOUNT_MUNICIPALITIES' | 'LOAN_BALLOON' | 'LOAN_BULLET' | 'LOAN_RATE_FIXED' | 'LOAN_RATE_VARIABLE' | 'LORO' | 'SDD_DEPOSIT' | 'SETTLEMENT' | 'SME_LOAN' | 'SURETY' | 'TAGESGELD_ACTIVE'

The type of account.

purposestring

The purpose of the account.

opened_atstring

UTC timestamp from when the account was opened.

statusstring

Current status of the account

locking_status'BLOCK' | 'CREDIT_BLOCK' | 'DEBIT_BLOCK' | 'NO_BLOCK'

Indicates whether or not funds can be transferred to or from the account.

locking_reasonsstring[]

Read-only indicator of the reason a block was applied to the account. If the account is not blocked, then this value will contain an empty array.

person_idstring

Person ID of the account owner.

business_idstring

ID of the business that owns the account (if applicable).

Example response

[
  {
    "id": "efdd8c5e7ec0b4e36768c6de39e6cfc0cacc",
    "iban": "DE05011010100000000043",
    "bic": "SOBKDEB2XXX",
    "purpose": "primary",
    "opened_at": "2020-04-25T12:50:33Z",
    "status": "ACTIVE",
    "locking_status": "BLOCK",
    "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
  }
]