get
https://api.instantpay.in/identity/sanctions/search
This API allows you to search for politically exposed entities using different full name or aliases.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code is "1" (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client Id Provided by Instantpay | M | Y |
| X-Ipay-Client-Secret | String | Unique Client Secret Provided by Instantpay | M | Y |
| X-Ipay-Endpoint-Ip | String | End customer IP Address | M | Y |
Request Parameters
| Parameter Name | Type | Requirement | Description |
|---|---|---|---|
| queryText | String | Mandatory | Full name or known aliases of the the Individual |
| latitude | String | Mandatory | End Customer Latitude. |
| longitude | String | Mandatory | End Customer Longitude |
| externalRef | String | Mandatory | Your Unique Transaction id |
| consent | String | Mandatory | Consent should be accepted by customer |
| limit | String | Optional | Number of result to return in the response |
| offset | String | Optional | Start at result with given offset |
Sample Request
GET /identity/sanctions/search?queryText=Yadav&consent=y&latitude=0&longitude=0&externalRef=1716180569&limit=10&offset= HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: {{clientId}
X-Ipay-Client-Secret: {{clientSecret}
X-Ipay-Endpoint-Ip: {{ipAddress}
X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234
X-Ipay-Request-Timestamp: 1659943695791
X-Ipay-Hash-Check: OFF
User-Agent: InstantPayAPITest/1.0.0GET /identity/sanctions/search?queryText=Yadav&consent=y&latitude=0&longitude=0&externalRef=1716180569&limit=10&offset= HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234
X-Ipay-Request-Timestamp: 1659943695791
X-Ipay-Hash-Check: OFF
User-Agent: InstantPayAPITest/1.0.0Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| statuscode | String | Instantpay Status Code |
| actcode | String | Action Code |
| status | Array | Status message |
| data | String | Response Data(if Present) |
| timestamp | String | Response 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 |
| internalCode | String | It will be null |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"searchData": {
"limit": 10,
"offset": 0,
"total": {
"value": 1,
"relation": "eq"
},
"results": [
{
"id": "Q122304",
"caption": "Nitish Kumar",
"schema": "Person",
"properties": {
"keywords": [
"State government",
"National government"
],
"name": [
"ニティーシュ・クマール",
"نتيش كمار",
"नीतिश कुमार",
"Нитиш Кумар",
"尼特·庫馬爾",
"Nitish Kumar",
"नीतीश कुमार",
"ניטיש קומאר",
"نیتیش کمار",
"ನಿತೀಶ್ ಕುಮಾರ್"
],
"alias": [
"尼蒂什·库玛尔",
"尼特·库马尔",
"尼蒂什·库马尔",
"尼蒂什·庫瑪爾"
],
"wikidataId": [
"Q122304"
],
"position": [
"Member of the 11th Lok Sabha",
"Chief Minister of Bihar (2015-)",
"Member of the 13th Lok Sabha",
"member of a Legislative Assembly of India",
"Member of the 9th Lok Sabha (1989-1991)",
"Member of the 12th Lok Sabha",
"Chief Minister of Bihar (2005-2014)"
],
"topics": [
"role.pep"
],
"country": [
"in"
],
"religion": [
"Hinduism"
],
"modifiedAt": [
"2024-05-03"
],
"website": [
"http://gov.bih.nic.in/Governance/NitishKumar.htm"
],
"birthPlace": [
"Bakhtiarpur"
],
"gender": [
"male"
],
"education": [
"National Institute of Technology, Patna"
],
"birthDate": [
"1951-03-01"
],
"nationality": [
"in"
],
"notes": [
"Indian politician and Current Chief Minister of Bihar"
]
},
"target": true,
"firstSeen": "2023-04-20T10:30:17",
"lastSeen": "2024-05-19T12:48:01",
"lastChange": "2024-05-08T00:47:01"
}
],
"facets": {
"topics": {
"label": "Topics",
"values": [
{
"name": "role.pep",
"label": "Politican",
"count": 1
}
]
},
"countries": {
"label": "Countries",
"values": [
{
"name": "in",
"label": "India",
"count": 1
}
]
}
}
},
"poolReferenceId": "1240520094857ZNSYR",
"pool": {
"openingBal": "23.64",
"mode": "DR",
"amount": "0.00",
"closingBal": "23.64"
}
},
"timestamp": "2024-05-20 09:48:57",
"ipay_uuid": "h0059c15e665-84b9-422b-9baa-6324f0284ecc-zFCN75SrVyTx",
"orderid": "1240520094857ZNSYR",
"environment": "LIVE"
}