TRtruelayer
Account Verification

Verify account details.

Verify supplied name, account type and date of birth with account holder's name, account type and date of birth.

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

post/v3/verification/fr/verify-account-details

Request

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

Headers

Authorizationstring bearer JWT required

Request body

namestring required

Account holder name to verify.

account_type'personal' | 'business' required

Account type to verify.

date_of_birthstring

Account holder date of birth to verify, in YYYY-MM-DD format.

Example request

{
  "name": "John Doe",
  "account_identifier": {
    "iban": "FR0218359000430598890U02758"
  },
  "account_type": "personal",
  "date_of_birth": "1977-12-21"
}

Response

OK

account_status'active' | 'inactive' | 'opted_out_from_scheme' | 'unknown' required

This field represents the current status of the account. It can have one of four possible values. </br>

active The account is currently active and in good standing.</br> inactive The account is currently inactive.</br> opted_out_from_scheme The account has been opted out of sharing details with the underlying scheme.</br> unknown The status of the account could not be determined.

Example response

{
  "name_match": {
    "type": "match",
    "match_score": 100
  },
  "account_type_match": {
    "type": "match"
  },
  "account_status": "active",
  "date_of_birth_match": {
    "type": "match"
  }
}

Changes

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