v1

latestOpenAPI 3.1.02026-07-2414704.6 MB

Search Profile

This API allows you to search for politically exposed entities using different full name or aliases.

get/sanctions/search

Headers

X-Ipay-Auth-Codestring

Auth Code

X-Ipay-Client-Idstring

Unique Client Id Provided by Instantpay

X-Ipay-Client-Secretstring

Unique Client Secret Provided by Instantpay

X-Ipay-Endpoint-Ipstring

End Customer IP Address

Request body

queryTextstring

Name of the Individual

latitudestring

End Customer Latitude.

longitudestring

End Customer Longitude.

externalRefstring

Your Unique Transaction id

consentstring

Consent should be accepted by customer

targetstring

Response

200

statuscodestring

{"stackTrail":"paths:/sanctions/search:get:responses:200:content:application/json:schema:properties:actcode","oasType":"schema","type":"unknown"}

statusstring

timestampstring

ipay_uuidstring

orderidstring

environmentstring

Example response

{
  "statuscode": "TXN",
  "status": "Transaction Successful",
  "data": {
    "searchData": {
      "limit": 10,
      "total": {
        "value": 1,
        "relation": "eq"
      },
      "results": [
        {
          "id": "Q122304",
          "caption": "Nitish Kumar",
          "schema": "Person",
          "properties": {
            "keywords": [
              "State government"
            ],
            "name": [
              "ニティーシュ・クマール"
            ],
            "alias": [
              "尼蒂什·库玛尔"
            ],
            "wikidataId": [
              "Q122304"
            ],
            "position": [
              "Member of the 11th Lok Sabha"
            ],
            "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"
}