Push Merchant API
Introduction
Following the completion of the Digilocker and OVD verification, the partner will push the Digilocker and OVD API responses to the Insurer through this API.
Sample Request
curl --location 'https://{base_URL}/api/distributors/pushMerchant' \
--header 'Authorization: ey**********NLEEzM6jBCL8' \
--header 'Content-Type: application/json' \
--data '{
"flowId":"62*********56",
"realmId":"62**********94",
"merchantId":"64***********c7",
"data": [
{
"pageId": "62*********4f",
"widgetName": "Aadhaar",
"data": {
"AadhaarImage1": "File URL",
"AadhaarImage2": "File URL",
"AadhaarName": "Name",
}
},
{
"pageId": "62**********4f",
"widgetName": "Digilocker Aadhaar",
"data": {
"AadhaarImage1": "File URL",
"AadhaarName": "Name",
"AadhaarUid": "Uid",
"AadhaarVid": "Vid",
}
},
{
"pageId": "62*********50",
"widgetName": "PAN to GST",
"data": {
"PANtoGSTApplicationStatus": "Application Status",
"PANtoGSTRegistrationName": "Registration Name",
"PANtoGSTMobNum": "Mobile Number",
"PANtoGSTRegType": "Registration Type",
}
},
{
"pageId": "62*********fa",
"widgetName": "Manual Data Entry",
"data": {
"address": "Aadhaaraddress",
"adhaaradress": "Aadhaar address",
"gstaddress": "GST address",
"enteraddress": "Enter Address"
}
},
{
"pageId": "62*********9e",
"widgetName": "Video Verification",
"data": {
"audioMatchScore": "Audio Match Score",
"videoMatchScore": "Video Match Score",
"videoCoVariance": "video CoVariance",
}
},
{
"pageId": "62********41",
"widgetName": "Business PAN",
"data": {
"BusinessPanImage": "File URL",
"BusinessPanName": "Name",
"BusinessPanDateOfIssue": "Date Of Issue",
"BusinessPanPanNumber": "Pan Number"
}
}
]
}'Key | Required/Optional | Data Type | Description |
|---|---|---|---|
Header | | | |
Authorization | Required | string | authorization token |
Content-Type | Required | string | application/json |
Body | | | |
flowId | Required | string | Flow that is assigned to the partner |
realmId | Required | string | This is an identifier used by the GO platform, the same will be provided by the Signzy team. |
merchantId | Required | string | This is a unique identifier of the merchant |
data | Required | array of objects | Contains data about various pages of the journey. |
pageId | Required | string | This is a unique identifier of the particular page during the various stages of the onboarding journey |
widgetName | Required | string | Name/type of the widget used for the stages of the journey. |
variables(variable 1, variable 2...) | Required | string | These are the key-value pairs of JSON generated by the page |
Sample Response
{
"result": "Successfully Pushed"
}Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].