Account verification

Account verification object

An account verification bears the results of several distinct verifications performed for a given account.

AttributeDescription
result
string
The result of the account verification. Can be:
  • pending_verification: the verification has been created and results are not yet available
  • valid: all results are available and valid
  • invalid: all results are available and at least one is invalid
  • valid_account_number
    object
    The result of the account number verification. It is composed of a result string and a details object.
    matching_account_number_and_bank_code
    object
    The result of the bank code verification. It is composed of a result string and a details object.
    matching_account_holder
    object
    The result of the holder's name verification. It is composed of a result string and a details object.
    matching_company_registration_number
    object
    The result of the company registration number verification. It is composed of a result string and a details object.
    active_account
    object
    The result of the account activity verification. It is composed of a result string and a details object.
    created_at
    object
    The UTC timestamp of the account verification.

    Below, an example of a 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":""
          },
        },
        "matching_company_registration_number": {
          "result": "valid",
          "details":{
            "reason":"",
            "message":"",
            "expected_value":""
          },
        },
        "active_account": {
          "result": "valid",
          "details":{
            "reason":"",
            "message":"",
          },
        },
        "created_at": "2022-01-03T11:53:19.734182Z",
      }
    }
    

    Verification object

    Each verification is composed of a result string and a details object, as described below:

    AttributeDescription
    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.

    Lists of possible reason per verification

    active_account

    reasonmessage
    inactiveThe account is inactive.
    unknownImpossible to get the account’s activity status.

    valid_account_number

    reasonmessage
    unauthorized_charactersThe account number has unauthorised characters.
    incorrect_account_check_digitThe account number checksum is incorrect.
    incorrect_iban_check_digitThe IBAN checksum is incorrect.
    incorrect_structureThe account number has an invalid structure.
    incorrect_lengthThe account number has an incorrect number of characters.
    country_doesnt_support_ibanThe country does not support IBAN.
    unsupported_account_number_kindaccount number type is not supported

    matching_account_number_and_bank_code

    reasonmessageexpected_value
    bic_not_matchingBank code and account number do not match. Account number belongs to {{suggested bank code}}.{{suggested bank code}}
    could_not_verifyImpossible to retrieve the bank code associated to this account number.

    matching_account_holder

    reasonmessageexpected_value
    close_matchThe holder entered is a close match to the registered holder.{{suggested holder's name}}
    no_matchThe holder entered does not match the registered holder.{{suggested holder's name}}
    could_not_matchImpossible to match the registered holder.

    matching_company_registration_number

    reasonmessage
    no_matchThe company registration number entered does not match the registered company registration number.
    could_not_matchImpossible to match the registered company registration number.