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
panNumber	String	Mandatory	Pan Number
dob	String	Mandatory	Date of Birth(YYYY-MM-DD)
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/ckyc' \
--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 'X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234' \
--header 'X-Ipay-Request-Timestamp: 1659943695791' \
--header 'X-Ipay-Hash-Check: OFF' \
--header 'User-Agent: InstantPayAPITest/1.0.0' \
--header 'Content-Type: application/json' \
--data '{
    "panNumber":"AAOCS6028B",
    "dob":"1997-09-03",
    "consent":"Y",
    "latitude":0.99,
    "longitude":38,
    "externalRef":"jdnjdi89"
}'

POST /identity/ckyc HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 2
X-Ipay-Client-Id: wiDLYLyGQc+21HPiah76S/HiAhx8pc2Hmkc9sXb7RDM=
X-Ipay-Client-Secret: a3d33c38bae71eca82bed090a1d0a757280563a2ed732521d20b8b78e2486190
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.0
Content-Type: application/json
Content-Length: 146

{
    "panNumber":"BQUPJ2729J",
    "dob":"1997-09-03",
    "consent":"Y",
    "latitude":0.99,
    "longitude":38,
    "externalRef":"jdnjdi89"
}

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": {
        "ckycDetail": {
            "personalDetails": {
                "constituitonType": "Individual",
                "accountType": "Normal",
                "ckycNumber": "1234567890",
                "userPrefix": "MR",
                "userFirstName": "Sample",
                "userLastName": "Name",
                "userFullName": "MR Sample  Name",
                "userFatherPrefix": "MR",
                "userFatherFirstName": "Sample  ",
                "userFatherLastName": "Name",
                "userFatherFullName": "MR Sample Name",
                "userMotherPrefix": "MRS",
                "userMotherFirstName": " Sample",
                "userMotherLastName": "Name",
                "userMotherFullName": "MR Sample Name",
                "userGender": "MALE",
                "userDob": "03-09-1997",
                "userPan": "AT*****9B",
                "addressPermanentLine1": "Address Line 1",
                "addressPermanentLine2": "Address Line 2",
                "addressPermanentLine3": "Locality Name",
                "addressPermanentCity": "City Name",
                "addressPermanentDistrict": "District Name",
                "addressPermanentState": "BR",
                "addressPermanentCountry": "IN",
                "addressPermanentPin": "Pincode",
                "addressPermanetPoa": "Driving License",
                "permanetCorrespondenceSameFlag": "Y",
                "addressCorrespondenceLine1": "Address Line 1",
                "addressCorrespondenceLine2": "Address Line 2",
                "addressCorrespondenceLine3": "Locality Name",
                "addressCorrespondenceCity": "City Name",
                "addressCorrespondenceDistrict": "Patna",
                "addressCorrespondenceState": "BR",
                "addressCorrespondenceCountry": "IN",
                "addressCorrespondencePin": "Pincode",
                "addressCorrespondencePoa": "03",
                "userMobileCode": "91",
                "userMobileNumber": "7428585742"
                "userEmail": "[email protected]",
                "declarationDate": "30-01-2023",
                "declarationPlace": "DELHI",
                "kycDate": "********",
                "documentSubmitted": "Certified Copies",
                "kycName": "********",
                "kycDesignation": "********",
                "kycBranch": "********",
                "kycEmpCode": "********",
                "numIdentity": "3",
                "numRelated": "0",
                "numImages": "5"
            },
            "identityDetails": {
                "identity": [
                    {
                        "sequenceNo": "1",
                        "identityType": "Driving Licence",
                        "identityNumber": "********",
                        "idVerificationStatus": "NO"
                    },
                    {
                        "sequenceNo": "2",
                        "identityType": "Proof of Possession of Aadhaar",
                        "identityNumber": "XXXXXXXX6077",
                        "idVerificationStatus": "NO"
                    },
                    {
                        "sequenceNo": "3",
                        "identityType": "E-KYC Authentication",
                        "identityNumber": "XXXXXXXX6077",
                        "idVerificationStatus": "NO"
                    }
                ]
            },
            "imageDetails": {
                "image": [
                    {
                        "sequenceNo": "1",
                        "imageType": "JPG",
                        "imageCode": "Proof of Possession of Aadhaar",
                        "globalFlag": "1",
                        "branchCode": "CPUB001",
                        "imageData": "*********"
                    },
                    {
                        "sequenceNo": "2",
                        "imageType": "JPEG",
                        "imageCode": "Photograph",
                        "globalFlag": "1",
                        "branchCode": "CPUB001",
                        "imageData": "********"
                    },
                    {
                        "sequenceNo": "3",
                        "imageType": "JPG",
                        "imageCode": "Signature",
                        "branchCode": "HOBR",
                        "imageData": "*******"
                    },
                    {
                        "sequenceNo": "4",
                        "imageType": "PDF",
                        "imageCode": "E-KYC Authentication",
                        "branchCode": "NORTH01BR",
                        "imageData": "**********"
                    },
                    {
                        "sequenceNo": "5",
                        "imageType": "JPG",
                        "imageCode": "Driving License",
                        "branchCode": "002BR",
                        "imageData": "******"
            }
        },
        "pool": {
            "referenceId": "1231031122531GUZRH",
            "openingBalance": "19.60",
            "paymentAmount": "11.80",
            "mode": "DR",
            "closingBalance": "7.80"
        }
    },
    "timestamp": "2023-10-31 12:25:31",
    "ipay_uuid": "h0689a7fc392-8e42-4f9d-9956-43ba00fc09c4-Djy5KDTZj6DW",
    "orderid": "1231031122531GUZRH",
    "environment": "LIVE",
    "internalCode": null
}