External account verification enables companies to verify external accounts prior to sending or collecting payments.

Account verification object

Attribute	Description
result string	Account verification result. It can be: `pending_verification`: verification is pending `valid`: results are available and all verifications are valid `invalid`: results are available but at least one verification is invalid
valid_account_number object	Account number verification result, including a `result` string and a `details` object.
matching_account_number _and_bank_code object	Bank code verification result, including a `result` string and a `details` object.
matching_account_holder object	Account holder verification result. For `counterparty_account` of type `legal_entity`, it includes the `company_registration_number`verification result. For `counterparty_account` of type `individual`, it includes the `account_holder_name` verification. It always includes a `result` string and a `details` object.
active_account object	Account activity verification result, including a `result` string and a `details` object.
created_at object	The UTC timestamp of the account verification.

Below is an example of an account_verification object for a counterparty account with all verifications valid:

{
  "account_verification": {
    "result":"valid",
    "valid_account_number": {
      "result": "valid",
      "details":{
        "reason":"",
        "message":"",
      },
    },
    "matching_account_number_and_bank_code": {
      "result": "valid",
      "details":{
        "reason":"",
        "message":"",
        "expected_value":""
      },
    },
    "matching_account_holder": {
      "result": "valid",
      "details":{
        "reason":"",
        "message":"",
        "expected_value":""
      },
    },
    "active_account": {
      "result": "valid",
      "details":{
        "reason":"",
        "message":"",
      },
    },
    "created_at": "2022-01-03T11:53:19.734182Z",
  }
}

Verification object

Every verification has its own object, with a result string and a details object as follows:

Attribute	Description
result string	The result of the sub-item verification. It can be `valid`, `invalid`, `impossible_to_verify` or `not_verified`.
details object	The details of the sub-item result, in case it is not `valid`.
details.reason string	The reason why the the sub-item is not `valid`, represented by a reason code. Please find below the list of possible reason codes per sub-item.
details.message string	A comprehensive message describing the reason.
details.expected_value string	For `matching_account_number_and_bank_code`, the bank code matching the account number, if a not-matching bank code has been provided. For `matching_account_holder`, the holder's name found as matching the holder's name provided.

Verification reasons

active_account

Reason	Message
inactive	The account is inactive.
unknown	Impossible to get the account’s activity status.

valid_account_number

Reason	Message
unauthorized_characters	The account number has unauthorised characters.
incorrect_account_check_digit	The account number checksum is incorrect.
incorrect_iban_check_digit	The IBAN checksum is incorrect.
incorrect_structure	The account number has an invalid structure.
incorrect_length	The account number has an incorrect number of characters.
country_doesnt_support_iban	The country does not support IBAN.
unsupported_account_number_kind	Account number type is not supported

matching_account_number_and_bank_code

Reason	Message	Expected value
bic_not_matching	Bank code and account number do not match. Account number belongs to {{suggested bank code}}.	Valid bank code
could_not_verify	Impossible to retrieve the bank code associated to this account number.

matching_account_holder

Reason	Message
close_match	The holder entered is a close match to the registered holder.
no_match	The holder entered does not match the registered holder.
could_not_match	Impossible to match the registered holder.

Test cases

📘
Test cases
Use our pre-made test cases to test and validate your integration.

Account verification object

Verification object

Verification reasons

active_account

valid_account_number

matching_account_number_and_bank_code

matching_account_holder

Test cases

📘Test cases

📘
Test cases