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
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

Sample Request

curl --location 'https://api.instantpay.in/identity/sanctions/profile/Q30252299?consent=y&latitude=0&longitude=0&externalRef=1715943599' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{ipAddress}}'

GET /identity/sanctions/profile/Q30252299?consent=y&latitude=0&longitude=0&externalRef=1715943599 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}}

Response 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": {
        "entityData": {
            "id": "Q30252299",
            "caption": "Sangram Yadav",
            "schema": "Person",
            "properties": {
                "topics": [
                    "role.pep"
                ],
                "wikidataId": [
                    "Q30252299"
                ],
                "gender": [
                    "male"
                ],
                "position": [
                    "Member of the Uttar Pradesh Legislative Assembly"
                ],
                "name": [
                    "Sangram Yadav"
                ],
                "nationality": [
                    "in"
                ],
                "notes": [
                    "Indian politician"
                ],
                "keywords": [
                    "State government"
                ],
                "birthDate": [
                    "1971-10-03"
                ],
                "modifiedAt": [
                    "2023-12-21"
                ],
                "country": [
                    "in"
                ],
                "positionOccupancies": [
                    {
                        "id": "wd-da16de6531c7bbc83ea227673bc80d251ddb32dc",
                        "caption": "Occupancy",
                        "schema": "Occupancy",
                        "properties": {
                            "holder": [
                                "Q30252299"
                            ],
                            "status": [
                                "unknown"
                            ],
                            "post": [
                                {
                                    "id": "Q18039836",
                                    "caption": "Member of the Uttar Pradesh Legislative Assembly",
                                    "schema": "Position",
                                    "properties": {
                                        "topics": [
                                            "gov.state"
                                        ],
                                        "country": [
                                            "in"
                                        ],
                                        "wikidataId": [
                                            "Q18039836"
                                        ],
                                        "name": [
                                            "Member of the Uttar Pradesh Legislative Assembly"
                                        ]
                                    },
                                    "target": false,
                                    "firstSeen": "2023-09-08T07:00:40",
                                    "lastSeen": "2024-05-19T13:37:33",
                                    "lastChange": "2023-12-22T14:40:54"
                                }
                            ]
                        },
                        "target": false,
                        "firstSeen": "2023-09-08T07:00:40",
                        "lastSeen": "2024-05-19T12:48:01",
                        "lastChange": "2023-09-08T07:00:40"
                    }
                ]
            },
            "target": true,
            "firstSeen": "2023-04-20T10:30:17",
            "lastSeen": "2024-05-19T12:48:01",
            "lastChange": "2024-01-31T00:47:01"
        },
        "poolReferenceId": "1240520102224FJADQ",
        "pool": {
            "openingBal": "23.64",
            "mode": "DR",
            "amount": "0.00",
            "closingBal": "23.64"
        }
    },
    "timestamp": "2024-05-20 10:22:24",
    "ipay_uuid": "h0059c15f25a-636b-4273-95b3-2c3e44ee87f8-STG9NGfDA808",
    "orderid": "1240520102224FJADQ",
    "environment": "LIVE"
}

200200

400400