post https://api.instantpay.in/identity/nameSimilarity
The Text Match API allows users to compare two names and returns a similarity score indicating how closely they match. This can be useful for applications involving name matching, duplicate detection, and fuzzy searches.
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code -1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameters
| Name | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| firstName | String | M | First name of the user |
| secondName | String | M | Second name of the user |
| externalRef | String | M | Your Unique Transaction Id |
Sample Request
curl --location --request POST 'https://api.instantpay.in/identity/nameSimilarity' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"firstName": "Instantpay India Ltd",
"secondName": "Instantpay Limited",
"externalRef": "1649750897",
}'
POST /identity/nameSimilarity HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
{
"firstName": "Instantpay India Ltd",
"secondName": "Instantpay Limited",
"externalRef": "1649750897",
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Current time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
Note :
1- externalRef must be unique and in alpha numeric characters.
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"ipayId": "122022149NPGPA",
"openingBalance": "12.14",
"closingBalance": "12.14",
"transactionValue": "0.00",
"payableValue": "0.00",
"similarityScore": 96.83
},
"timestamp": "2022-08-17 12:21:49",
"ipay_uuid": "h068970aa142-66d2-4ee5-bd1b-d6029b9fa0fe",
"orderid": "1230424215619QEDEL",
"environment": "LIVE",
"internalCode": null
}
You can categorize the match percent results using the table below.
| Similarity Score | Match Result |
|---|---|
| 100 | Exact Match |
| 85.00 - 99.00 | Close Match |
| 60.00 - 84.00 | Moderate Match |
| 34.00 - 59.00 | Poor Match |
| 1 - 33.00 | No Match |