Text Match

An intelligent name matching service returning a confidence level from 0% to 100%.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
firstNameStringMFirst name of the user
secondNameStringMSecond name of the user
externalRefStringMYour 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

statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )


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": 100
    "timestamp": "2022-08-17 12:21:49",
    "ipay_uuid": "h068970aa142-66d2-4ee5-bd1b-d6029b9fa0fe",
    "orderid": "1230424215619QEDEL",
    "environment": "LIVE",
    "internalCode": null
Click Try It! to start a request and see the response here!