Create Session

Create Session API creates a Face Liveness session and returns a unique SessionId and accessToken.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
latitudeStringMCurrent location Latitude
longitudeStringMCurrent location Longitude
externalRefStringMYour Unique Transaction Id

Sample Request

curl --location 'https://api.instantpay.in/identity/faceLiveness/createSession?latitude=-33.2442&longitude=-106.3922&externalRef=1720521988' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1' \
--header 'X-Ipay-Endpoint-Ip: 49.111.0.1' \
--data ''
GET /identity/faceLiveness/createSession?latitude=-6.5903&longitude=93.6001&externalRef=1720522027 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: 49.111.0.1

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox

📘

Note :

1- externalRef must be unique and in alpha numeric characters.

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Sucesses",
    "data": {
        "sessionId": "fdabfdc0-fba6-41d8-879c-30df24671f05",
        "accessToken": "SVFvSmIzSnBaMmx1WDJWakVHhOdmRYUUFpQlVMdk4xdkdoOW80QkJSak1YcWY0MFhsS21iVnlZK1kwQitEa3Y5UGZpR0FJZ1I5S0NjMnB6c2hZVzFTQWpPa1VOQ3Q0ZmpoM0ZVUE83T1JXeFRjNElsQWNxeUFVSUt4QUFHZ3cyTkRRNE56azJOVGM0T1RRaURKaEgvYTE3RFhITGNIZ05mU3FsQlI5VzJnbW8xQjhGbWdydDZmV2gybVQ1S2EzTmZLblo4Y29BeUJaOVJNaGhpeFBxVnFZOU5SNk1jYXJReDcvSlF1cWJVa1ludHdITlJqRFBPQzk5clNOMm1RSkZSV0d1aVNUUGRROUhQN3JPUDcvVldtMEV4dmVpcGc1Z3pFVVllSlhiN1dyWUtjRUpQckxnd1p5MjlwY255Sk5oRzJKcE5RMWtUUWZLdjJlWGZPb2ljSWNmZzBCdVk3NTVzTmswN3hNbnRRVGtva25RbEhLOFpVcTlFT3IxU0ZTVTEvbHprSVJxc2psR3c1a2JKeVY2eW0rWGQ0YjI3aXRQeFo3bUh0QUgwVkRPcXRoa1ZSb2MxVFhNNERacVZkQUlYeHhTdHVHMWxLZlpQOVM1UWJ6ampGNzhncjBDQTR5SkFMbGdxNkdxUEd3QWpjeUc3VFFwaFM2c3dtNVAxUHpLMHZMQS9aOXB5Nit1QVpENTd6bnMxKy91QSs2REdJSkZCMWZ3eUFCZXJSTWxOenNoc2F3Z25XWmFqSmNCc1FkTXBnQWh3VUw3RWUvMEgwd2ZLQjlPTm15ZUlCcmtiVUd6MG05dDFnS0ZKU05Kb0tvSjRCa25yT05pU1FqcTNLNG5LU0JndVRtZnpXR1FVdWJaajdQUVRqWUtCUDNsZmQyWUJEc1dCcU1ZQzMwaUI4WGxJRWpRSUpNc3dvaW1zTWtvR3k1ZmxsNkp5bTlqUVVKSEVOR3lPekxmRGl4UXRxY3VwQnQ1cExEZzliU2JjTGI1WWJsUStCaVEzREVVUXYreWhKRDFpcW1OQ3EvUUJibEk1bGpiazlybnM5STFhWmtaL0RuMkFjODQybGpWRk1ZempGTzlHK3BoOTNjVVhJcTBOZEVIeC9ieHFjUUhOUVpqVHNuT042L2xBODdhVmp5N21ZMGxrV05EMEV6ZGkyOWFFazBLT1Z4ZjZrdlE3RkZRejNoYjdoQVJ0eWJpdktJM045ZXRqMEpRN1Vleko0ejFpTmlKSVhGbUxvZWlqR1h0SFA5UnRlZkZmQkpubjhKWUg2aUxGNnBCM1JGbkU5ZnAzQU0veXdDaUpheU1lVFp3bHRxUk1xYnJObnEzaFFSVGF1bWthUEZEQ1dtQlZXcUtNNFZKUENWUXZIb3dkVnV6VlVyaVJGL3JpaTZCbm85bGpWeUlwNXJvbW1rSk1JNkh0TFFHT3VFQ2JhNUdSclhnTTV4SW4rN0xrU2tsaTJ5YmFkY1RqRTNISkRVZ0U0MjFzMFlKRlNSZnNCS2ZwdDdoeUo3SGxLSml2Z0NMaXNUMlNraTFZa3dFK3dvZjA0TE9zYUQ2MUdmUGlhUUQ4bU5UTlNNdnR5dEtEcThQZVRpRStZUUxKTEtBYWhzaUh2SjZRY2JwY1J6VVNONW9iR0xlVG9rdGZkSGY2UmVwTHNOb2VGa240QVZYTVd4Vm82TCtrYUpHcjZxemhLTTYya3dhZnQ5VFhvb3kyWlZhODNxcHVhZ3J5bU9FU0FrUktydjQwblpXVmhCOS9JVmhlTE14QjFXQ213UVh0QkVRNVhNZUJFTklVMFRvTWYvRS9oditTRDZHYnJ5bmtvTk1wNWdoaTRSOFE5b1dhaHJOYUd1U0NUTXA1MmVZczgwTXpObmVsR2grVzdGcFhOOWVTVUtUR0RvbmFicTc3eEViVDdaUVJOODlMTEkwbXNBVHNlM0p6UzNwTWsreDJ3MDhZdFo1eE1DMGduVVN3SFBjR3Z5NTF6UVh0MmsrRi9NWHZtL1IxS2JVNm04VzdpeVRCeGpCTDBNNzBic0s4TDJvMzYveGJMMDJTaXYzSTV5SlNJST0jI1BodTVJT3FBNlErSlgraGVnZkIvVjg3cUJ0QUxtTG5RMXpGYm1TUDEjIzVLNkhMTEFHVE9WU09KTVpBSVNB",
        "poolReferenceId": "1240709150158FAKAV",
        "pool": {
            "openingBal": "13.97",
            "mode": "DR",
            "amount": "0.00",
            "closingBal": "13.97"
        }
    },
    "timestamp": "2024-07-09 15:01:58",
    "ipay_uuid": "h0009c7aeb8d-3b0f-4c91-af8f-b59b2b9c8f58-xdPdjB2KKBtl",
    "orderid": "1240709150158FAKAV",
    "environment": "LIVE"
}
Language
Click Try It! to start a request and see the response here!