post https://api.instantpay.in/identity/nameAbbreviations
Instantpay's Name Abbreviator API generates standardised name abbreviations with high efficiency. It improves accuracy in processes like KYC verification. This API simplifies name management. It makes short versions for use where brevity and consistency are key. They're great for validating names.
Integrating the Name Abbreviator API will optimise name validation. It will support fast and accurate identity verification. This tool is vital for groups that value accurate, efficient customer data management.
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 |
|---|---|---|---|
| Name | String | M | name of the user |
| maxLength | String | O | Maximum length allowed |
| externalRef | String | M | Your Unique Transaction Id |
Sample Request
curl --location --request POST 'https://api.instantpay.in/identity/nameAbbreviations' \
--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 '{
"name": "Sample Name",
"maxLength": "26",
"externalRef": "1650279339"
}'
POST /identity/nameAbbreviations 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
{
"name": "Sample Name",
"maxLength": "26",
"externalRef": "1650279339"
}'
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": "1220418164539ZBMFR",
"openingBalance": "13.46",
"closingBalance": "13.46",
"transactionValue": "0.00",
"payableValue": "0.00",
"abbreviations": [
"Sample N",
"S Name",
"Sample Name"
]
},
"timestamp": "2022-04-18 16:45:39",
"ipay_uuid": "h00596179688-8454-4a48-8783-531e2952d282",
"orderid": "1220418164539ZBMFR",
"environment": "LIVE",
}