API Specifications

POST

/api/v1/bank-accounts/validate

Validates a bank account by comparing it with the provided payee name or identification number. The response includes a match indicator, reason code, and additional bank and SEPA information.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Request successfully processed, with account validation details.

Headers

Body

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

cURL

IBAN Name RequestIBAN Name Request without Responding BICIBAN Identification RequestIBAN Identification Request without Responding BICSortCodeAccountNumber Request

curl --location --request POST 'https://mock.apidog.com/m1/1198618-0-default/api/v1/bank-accounts/validate' \
--header 'x-fapi-financial-id: acMxgBFTYZMU5Xkte00' \
--header 'x-fapi-interaction-id: 123e4567-e89b-12d3-a456-426614174000' \
--header 'Accept: application/json' \
--header 'cop-requester-id: COP12345REQ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Data": {
        "SchemeName": "IBAN",
        "Identification": "GB29NWBK60161331926819",
        "Name": "Hillary Brown",
        "SecondaryIdentification": "Shopping",
        "RespondingBic": "CMCIFRPPXXX"
    }
}'

Response Example

200 - Match

{
    "Status": "Confirmed",
    "Message": "Payee's Bank has performed the matching and confirms it is a match.",
    "CreationDateTime": "2025-01-15 11:28:22.724",
    "StatusUpdateDateTime": "2025-01-15 11:28:22.827",
    "Data": {
        "VerificationReport": {
            "Matched": true
        }
    }
}

Requester – Payee Verification (JSON)

Requester – Payee Verification (XML)