Skip to main content
POST
/
recipients
/
validate
/
account
Validate a bank account
curl --request POST \
  --url https://api.equalsmoney.com/v2/recipients/validate/account \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "GB",
  "iban": "PK94XAOM0400102322019126",
  "number": "55555555",
  "code": "12-34-56"
}
'
{
  "countryCode": "GB",
  "nationalId": "string",
  "accountNumber": "string",
  "status": "PASS",
  "comment": "string",
  "recommendedNatId": "string",
  "recommendedAcct": "string",
  "recommendedBIC": "string",
  "ref": "string",
  "group": "string",
  "branchDetails": [
    {
      "bankName": "Barclays Bank",
      "branch": "London",
      "street": "1 Churchill Place",
      "city": "London",
      "postZip": "E14 5HP",
      "region": "London",
      "country": "UK",
      "codeDetails": {
        "codeName1": "string",
        "codeValue1": "string",
        "codeName2": "string",
        "codeValue2": "string",
        "codeName3": "string",
        "codeValue3": "string",
        "codeName4": "string",
        "codeValue4": "string"
      },
      "additionalData": {
        "ssiAvailable": "Y",
        "payServiceAvailable": "Y",
        "contactsAvailable": "N",
        "messageAvailable": "N",
        "holidayAvailable": "Y",
        "sepaDetails": {
          "ctStatus": "NO",
          "ddStatus": "NO",
          "bbStatus": "NO"
        },
        "bankToken": "string",
        "branchTypeLabel": "string"
      }
    }
  ],
  "headOfficeDetails": {
    "bankName": "Barclays Bank",
    "branch": "London",
    "street": "1 Churchill Place",
    "city": "London",
    "postZip": "E14 5HP",
    "region": "London",
    "country": "UK",
    "codeDetails": {
      "codeName1": "string",
      "codeValue1": "string",
      "codeName2": "string",
      "codeValue2": "string",
      "codeName3": "string",
      "codeValue3": "string",
      "codeName4": "string",
      "codeValue4": "string"
    },
    "additionalData": {
      "ssiAvailable": "Y",
      "payServiceAvailable": "Y",
      "contactsAvailable": "N",
      "messageAvailable": "N",
      "holidayAvailable": "Y",
      "sepaDetails": {
        "ctStatus": "NO",
        "ddStatus": "NO",
        "bbStatus": "NO"
      },
      "bankToken": "string",
      "branchTypeLabel": "string"
    }
  },
  "paymentBicDetails": {
    "bankName": "Barclays Bank",
    "branch": "London",
    "street": "1 Churchill Place",
    "city": "London",
    "postZip": "E14 5HP",
    "region": "London",
    "country": "UK",
    "codeDetails": {
      "codeName1": "string",
      "codeValue1": "string",
      "codeName2": "string",
      "codeValue2": "string",
      "codeName3": "string",
      "codeValue3": "string",
      "codeName4": "string",
      "codeValue4": "string"
    },
    "additionalData": {
      "ssiAvailable": "Y",
      "payServiceAvailable": "Y",
      "contactsAvailable": "N",
      "messageAvailable": "N",
      "holidayAvailable": "Y",
      "sepaDetails": {
        "ctStatus": "NO",
        "ddStatus": "NO",
        "bbStatus": "NO"
      },
      "bankToken": "string",
      "branchTypeLabel": "string"
    }
  },
  "paymentNetworkDetails": [
    {
      "paymentNetwork": "SWIFT",
      "participantId": "string",
      "participantName": "string",
      "currencyCode": "AED"
    }
  ],
  "bic8": "N",
  "dataStore": "N",
  "noBranch": "N",
  "isoAddr": "N",
  "payBranchType": "D",
  "freeToken": "string"
}

Documentation Index

Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

​
include
enum<string>

Comma-separated list of fields to include in the response.

Available options:
paymentNetworkDetails
Example:

"paymentNetworkDetails"

Body

application/json

Body

​
country
string
required

The country, in ISO 3166-1 alpha-2 format.

Maximum string length: 2
Example:

"GB"

​
iban
string | null

The International Bank Account Number (IBAN).

Example:

"PK94XAOM0400102322019126"

​
number
string | null

The bank account number.

Example:

"55555555"

​
code
string | null

The bank sort code.

Example:

"12-34-56"

Response

200 - application/json

OK

​
countryCode
string | null
Example:

"GB"

​
nationalId
string | null
​
accountNumber
string | null
​
status
string | null
Example:

"PASS"

​
comment
string | null
​
recommendedNatId
string | null
​
recommendedAcct
string | null
​
recommendedBIC
string | null
​
ref
string | null
​
group
string | null
​
branchDetails
object[] | null
​
headOfficeDetails
object
​
paymentBicDetails
object
​
paymentNetworkDetails
object[]

Provides a list of payment networks through which payments can be sent to the validated account. Each entry includes the network name and details of the participating institution.

​
bic8
string | null
Example:

"N"

​
dataStore
string | null
Example:

"N"

​
noBranch
string | null
Example:

"N"

​
isoAddr
string | null
Example:

"N"

​
payBranchType
string | null
Example:

"D"

​
freeToken
string | null