POST
/
name-match
{
  "verification_id": "ABC00123",
  "reference_id": 12345,
  "name_1": "JOHN DOE",
  "name_2": "JOHN DOE",
  "status": "SUCCESS",
  "score": 1,
  "reason": "The given names are identical"
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Body

application/json

Find the request parameters for the Name Match API

name_1
string
default:
JOHN DOE
required

It is the name you want to verify.

name_2
string
default:
JOHN DOE
required

It is the name you want to verify with name_1.

verification_id
string
default:
ABC00123
required

It is the unique ID you need to create to identify the verification request. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-) and underscore ( _ ) are allowed.

Response

200 - application/json

Success response for Name Match API

name_1
string

It displays the name you entered for verification.

name_2
string

It displays the name you entered for verificaiton with name_1.

reason
string

It justifies the match score for the API request.

reference_id
integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

score
number

It displays the score for name match verification, with values ranging from 0 to 1.

status
string

It displays the status of the API request. Possible values are

  • SUCCESS: A successful name match.
verification_id
string

It displays the unique ID you created to identify the verification request.