Outlet Ekyc Process

This API is used to submit the customer documents.

Request Parameters

Parameters NameRequirementDescription
referenceKeyMandatoryYou will get from Initiate KYC for Remitter API
remitterIdMandatoryRemitter Id of the Remitter
biometricData.rdsIdMandatoryReturned by RD Service when using biometric authentication. RD Service Id.
biometricData.rdsVerMandatoryReturned by RD Service when using biometric authentication. RD Service version.
biometricData.ciMandatoryReturned by RD Service when using biometric authentication. Public key certificate identifier of UIDAI using which skey was encrypted.
biometricData.dcMandatoryReturned by RD Service when using biometric authentication. Registered Device code.
biometricData.dpIdMandatoryReturned by RD Service when using biometric authentication. Device provider Id.
biometricData.hmacMandatoryReturned by RD Service when using biometric authentication. SHA -256 Hash of PID XML and then encrypted and base 64 encoded
biometricData.mcMandatoryReturned by RD Service when using biometric authentication. encrypted registered device public key certificate
biometricData.miMandatoryReturned by RD Service when using biometric authentication. RD model Id.
biometricData.pidDataMandatorybase-64 encoded encrypted pid block.
biometricData.sessionKeyMandatoryReturned by RD Service when using biometric authentication. AES session key generated dynamically for every txn

Sample Request

POST /fi/remit/out/nepal/outletEkycProcess HTTP/1.1
Host: api.localhost
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1
X-Ipay-Endpoint-Ip: 125.0.0.1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 473

{
    "referenceKey":"INSFDh000982646e4-3779-4e65-a362-9d9af55751e9",
    "biometricData": {
        "rdsId":"MANTRA.WIN.001",
        "rdsVer":"1.0.6",
        "ci": "20250929",
        "dc": "04e901f3-e07b-4ac2-a93e-840dff421a49",
        "dpId": "MANTRA.MSIPL",
        "hmac": "ebABrIPUq26YpSSKPE3WRKuRmudQOyyEABdw7AxoQs1hvdKG6asEQifO1ARZcnv/",
        "mc": "",
        "mi": "MFS100",
        "pidData": "",
        "sessionKey": "="
    },
    "remitterId": "7997"
}
curl --location 'http://api.localhost/fi/remit/out/nepal/outletEkycProcess' \
--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: 125.0.0.1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
    "referenceKey":"INSFDh000982646e4-3779-4e65-a362-9d9af55751e9",
    "biometricData": {
        "rdsId":"MANTRA.WIN.001",
        "rdsVer":"1.0.6",
        "ci": "20250929",
        "dc": "04e901f3-e07b-4ac2-a93e-840dff421a49",
        "dpId": "MANTRA.MSIPL",
        "hmac": "ebABrIPUq26YpSSKPE3WRKuRmudQOyyEABdw7AxoQs1hvdKG6asEQifO1ARZcnv/",
        "mc": "",
        "mi": "MFS100",
        "pidData": "",
        "sessionKey": "="
    },
    "remitterId": "7997"
}'

Response Parameter

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 )
enviromentStringLive/Sandbox

📘

Info :

For API Headers Click Here

Language
Click Try It! to start a request and see the response here!