v1
latestOpenAPI 3.1.02026-07-24180245513.9 KBExternal Accounts
List external accounts
List and filter external accounts.
get/external_accounts
Query parameters
limitinteger
starting_afterstring uuid
The ID of the object from which your list request will start. It is not included in the result.
sort_order'asc' | 'desc'
Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.
start_datestring date
The creation date of the external account.
end_datestring date
The creation date of the external account.
holder_namestring
The holder name of the external account.
account_numberstring
The account number of the external account.
bank_codestring
The bank code of the external account.
countrystring
The country of the external account.
status'pending_approval' | 'approved' | 'denied' | 'disabled'
The status of this external account.
The status of the external account.
Response
200
Example response
{
"records": [
{
"object": "external_account",
"holder_name": "Joe Black",
"account_number": "FR1420041010050500013M02606",
"organization_identification": {
"legal_entity_identifier": "529900T8BM49AURSDO55",
"business_identification_code": "SOMEBIC0XXX",
"default_other_identifier_type": "siren",
"others": [
{
"type": "siren",
"value": "901250746"
}
]
},
"bank_code": "BNPAFRPPXXX",
"holder_address": {
"line_1": "1, rue de la Bourse",
"building_number": "1",
"street_name": "rue de la Bourse",
"postal_code": "59000",
"city": "Lille",
"country": "FR"
},
"bank_name": "BankCo",
"bank_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"account_verification": {
"result": "valid",
"valid_account_number": {
"result": "valid",
"details": {
"reason": "unauthorized_characters",
"expected_value": "SOMEBIC0XXX",
"message": "IBAN contains unauthorized characters"
}
},
"matching_account_number_and_bank_code": {
"result": "valid",
"details": {
"reason": "unauthorized_characters",
"expected_value": "SOMEBIC0XXX",
"message": "IBAN contains unauthorized characters"
}
},
"matching_account_holder": {
"result": "valid",
"details": {
"reason": "unauthorized_characters",
"expected_value": "SOMEBIC0XXX",
"message": "IBAN contains unauthorized characters"
}
},
"active_account": {
"result": "valid",
"details": {
"reason": "unauthorized_characters",
"expected_value": "SOMEBIC0XXX",
"message": "IBAN contains unauthorized characters"
}
}
},
"metadata": {
"property_a": true,
"property_b": "some text"
}
}
]
}