TRtruelayer
Account Verification

Verify account holder name.

Verify supplied name with account holder's name.

Headers Required: Authorization (JWT) Token with bearer scheme format is required to make a call to Verification API.

post/verification/v1/verify

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/verification/v1/verify
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: verification

Headers

Authorizationstring bearer JWT required

Request body

namestring required

The name supplied by the client that needs to be matched with the account holder name at the bank.

Sample Request Example:

{
      "name": "Jack Johnson"
}

Max length: 200 characters.

Example request

{
  "name": "Jack Johnson"
}

Response

OK

verifiedboolean

Indicates whether the name values (the name you provide, and the name on file at the bank) meet the match_score threshold. If the match_score is greater than the set threshold, verified will be true. If not, verified will be false. By default, this threshold is 54.

account_holder_namestring

Account holder's name.

match_scoreinteger

A score between 0 and 100 (inclusive) that indicates how closely the supplied name matches the name on the account. This value is used to determine whether the user's name is successfully verified.

failure_descriptionstring

The description returned when account is not verifiable, which explains why.

failure_codestring

Failure code

Changes

No recorded changes to this operation across all 1 revision of this API.