Push Merchant Spec API

5min

Introduction
Using this API, the partner would push all the required fields to Signzy, and then Signzy will initiate the OCR and verification process.
Sample Request
Preproduction
Curl
curl --location 'https://go-preproduction.signzy.app/api/distributors/pushMerchantSpec/{applicationid}sampleData=true' \
--header 'Authorization: ey*************4MXsC4SlH4p72at_-Jlw'
curl --location 'https://go-preproduction.signzy.app/api/distributors/pushMerchantSpec/{applicationid}sampleData=true' \
--header 'Authorization: ey*************4MXsC4SlH4p72at_-Jlw'
﻿
Request Field Description
Key
Required/Optional
Data Type
Description
Authorization
Required
string
Authorization Token
Sample Response
JSON
{
"flowId": "62********56",
"realmId": "62********94",
"merchantId": "Merchant ID",
"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",
}
},
{
"pageId": "62********50",
"widgetName": "PAN to GST",
"data": {
"PANtoGSTAdditionalPlaceDistrict": "Additional Place District",
"PANtoGSTAdditionalPlaceState": "Additional Place State",
"PANtoGSTAdditionalPlacePincode": "Additional Place Pincode"
}
},
{
"pageId": "62********fa",
"widgetName": "Manual Data Entry",
"data": {
"address": "Select you business registered address",
"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"
}
}
]
}
{
"flowId": "62********56",
"realmId": "62********94",
"merchantId": "Merchant ID",
"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",
}
},
{
"pageId": "62********50",
"widgetName": "PAN to GST",
"data": {
"PANtoGSTAdditionalPlaceDistrict": "Additional Place District",
"PANtoGSTAdditionalPlaceState": "Additional Place State",
"PANtoGSTAdditionalPlacePincode": "Additional Place Pincode"
}
},
{
"pageId": "62********fa",
"widgetName": "Manual Data Entry",
"data": {
"address": "Select you business registered address",
"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
Data Type
Description
flowId
string
Flow that is assigned to the partner
realmId
string
This is an identifier used by the GO platform, the same will be provided by the Signzy team.
merchantId
string
This is a unique identifier of the merchant
data
array of objects
Contains data about various pages of the journey.
pageId
string
This is a unique identifier of the particular page during the various stages of the onboarding journey
widgetName
string
Name/type of the widget used for the stages of the journey.
variables(variable 1, variable 2...)
string
These are the key-value pairs of JSON generated by the page
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].
﻿

Key	Required/Optional	Data Type	Description
Authorization	Required	string	Authorization Token

Key	Data Type	Description
flowId	string	Flow that is assigned to the partner
realmId	string	This is an identifier used by the GO platform, the same will be provided by the Signzy team.
merchantId	string	This is a unique identifier of the merchant
data	array of objects	Contains data about various pages of the journey.
pageId	string	This is a unique identifier of the particular page during the various stages of the onboarding journey
widgetName	string	Name/type of the widget used for the stages of the journey.
variables(variable 1, variable 2...)	string	These are the key-value pairs of JSON generated by the page

Updated 30 Nov 2023

Did this page help you?

Partner Create Merchant API

Push Merchant API