Pull Merchant API (Partner)

5min
Introduction
If a client wants to get the data for a specific merchant, then call this API with the merchant ID that was generated in the create merchant API.
Sample Request
Preproduction
Curl
curl --location 'https://go-preproduction.signzy.app/api/distributors/pullMerchant/64ca5a8cc4d83d01453778c7?realmId=62df8e46fa3308fa636ccf94&version=1.1.0' \
--header 'Authorization: ey**********NLEEzM6jBCL8' 
curl --location 'https://go-preproduction.signzy.app/api/distributors/pullMerchant/64ca5a8cc4d83d01453778c7?realmId=62df8e46fa3308fa636ccf94&version=1.1.0' \
--header 'Authorization: ey**********NLEEzM6jBCL8' 
﻿
Request Field Description
Key
Required/Optional
Data Type
Description
Authorization
Required
string
Authorization Token
Sample Response 
JSON
400
401
{
"result": {
"merchantSignup": {},
"merchantData": {
"basicDetails": {
"id": "64********c7",
"name": "..name..",
"email": "..email..",
"mobile": "..mobile..",
"username": "..username..",
"realm": "..realm..",
"applicationId": "62*******94",
"distributorId": "62*******31",
"isDeleted": false,
"backopsUserId": "",
"realmId": "62********94",
"signzyAppId": "dh********25",
"autogeneratedUsername": true,
"regex": "",
"onboardingStartDate": 1690983052861,
"status": "pending",
"flowDetails": {
"name": "..name..",
"type": "..type.."
},
"autoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl********FjNQ",
"loginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortLoginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortAutoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl**********FjNQ",
"eventSource": "webapp",
"eventStatus": "onboardingCompleted",
"initialSubmissionDate": 1690983191120,
"onboardingEndDate": 1690983191120,
"subStatus": "allKYCDone",
"decisionEngineResult": "uncertain",
"internalNotes": [],
"backopsUserDetails": {}
},
"documents": [
{
"AadhaarImage1": "File URL",
"AadhaarName": "Name",
"AadhaarUid": "Uid",
"AadhaarVid": "Vid",
"AadhaarDob": "Date Of Birth",
"AadhaarYob": "Year Of Birth",
"AadhaarPincode": "Pincode",
"AadhaarAddress": "Address",
"AadhaarGender": "Gender",
"AadhaarUidHash": "UID Hash",
"Aadhaarstate": "State",
"Aadhaardistrict": "District",
"Aadhaarcity": "City",
"Aadhaarcountry": "Country",
"type": "Digilocker Aadhaar",
"widgetName": "Digilocker Aadhaar"
},
{
"PANtoGSTApplicationStatus": "Application Status",
"PANtoGSTRegistrationName": "Registration Name",
"PANtoGSTMobNum": "Mobile Number",
"PANtoGSTRegType": "Registration Type",
"PANtoGSTEmailId": "Email Id",
"PANtoGSTTinNumber": "Tin Number",
"PANtoGSTGstinRefId": "Gstin RefId",
"PANtoGSTGstin": "Gstin",
"PANtoGSTConstitutionOfBusiness": "Constitution Of Business",
"PANtoGSTLegalNameOfBusiness": "Legal Name Of Business",
"PANtoGSTTradeNameOfBusiness": "Trade Name Of Business",
"PANtoGSTCentreJurisdiction": "Centre Jurisdiction",
"PANtoGSTStateJurisdiction": "State Jurisdiction",
"PANtoGSTRegistrationDate": "Registration Date",
"PANtoGSTTaxPayerDate": "Tax Payer Date",
"PANtoGSTTaxPayerType": "Tax Payer Type",
"PANtoGSTGstinStatus": "Gstin Status",
"PANtoGSTCancellationDate": "Cancellation Date",
"PANtoGSTNatureOfBusinessActivities": "Nature Of Business Activities",
"PANtoGSTPrincipalPlaceAddress": "Principal Place Address",
"PANtoGSTPrincipalPlaceLatitude": "Principal Place Latitude",
"PANtoGSTPrincipalPlaceLongitude": "Principal Place Longitude",
"PANtoGSTPrincipalPlaceBuildingNameFromGST": "Principal Place Building Name From GST",
"PANtoGSTPrincipalPlaceBuildingNoFromGST": "Principal Place Building No From GST",
"PANtoGSTPrincipalPlaceFlatNo": "Principal Place Flat No",
"PANtoGSTPrincipalPlaceStreet": "Principal Place Street",
"PANtoGSTPrincipalPlaceLocality": "Principal Place Locality",
"PANtoGSTPrincipalPlaceCity": "Principal Place City",
"PANtoGSTPrincipalPlaceDistrict": "Principal Place District",
"PANtoGSTPrincipalPlaceState": "Principal Place State",
"PANtoGSTPrincipalPlacePincode": "Principal Place Pincode",
"PANtoGSTAdditionalPlaceAddress": "Additional Place Address",
"PANtoGSTAdditionalPlaceLatitude": "Additional Place Latitude",
"PANtoGSTAdditionalPlaceLongitude": "Additional Place Longitude",
"PANtoGSTAdditionalPlaceBuildingNameFromGST": "Additional Place Building Name From GST",
"PANtoGSTAdditionalPlaceBuildingNoFromGST": "Additional Place Building No From GST",
"PANtoGSTAdditionalPlaceFlatNo": "Additional Place Flat No",
"PANtoGSTAdditionalPlaceStreet": "Additional Place Street",
"PANtoGSTAdditionalPlaceLocality": "Additional Place Locality",
"PANtoGSTAdditionalPlaceCity": "Additional Place City",
"PANtoGSTAdditionalPlaceDistrict": "Additional Place District",
"PANtoGSTAdditionalPlaceState": "Additional Place State",
"PANtoGSTAdditionalPlacePincode": "Additional Place Pincode",
"type": "PAN to GST",
"widgetName": "PAN to GST"
},
{
"BusinessPanImage": "File URL",
"BusinessPanName": "Name",
"BusinessPanDateOfIssue": "Date Of Issue",
"BusinessPanPanNumber": "Pan Number",
"type": "Business PAN",
"widgetName": "Business PAN"
}
],
"formData": {
"address": "Aadhaaraddress",
"adhaaradress": "Aadhaar address",
"gstaddress": "GST address",
"enteraddress": "Enter Address",
"widgetName": "Manual Data Entry"
},
"videoForensics": {
"audioMatchScore": "Audio Match Score",
"videoMatchScore": "Video Match Score",
"videoCoVariance": "video CoVariance",
"videoFinalImage": "https://preproduction-persist.signzy.tech/api/files/3***3/download/image.jpg",
"videoUrl": "https://preproduction-persist.signzy.tech/api/files/3***3/download/image.jpg",
"videoOtp": "https://preproduction-persist.signzy.tech/api/files/3***3/download/image.jpg",
"videoFaceLandmark": "Video Face Landmark Image URL",
"videoPrerecordedRisk": "Video Pre-recorded Risk",
"videoStaticRisk": "video Static Risk",
"videoLandMark": "Video Landmark",
"type": "Video Verification",
"widgetName": "Video Verification"
},
"videoKyc": [],
"contract": {},
"contractSDK": {},
"products": [],
"data": [],
"browserAndLocationInfo": {},
"appAndLocationInfo": {},
"matcherData": [],
"internalNotes": []
},
"merchantAuditData": [],
"submerchantAuditData": []
}
}
{
"result": {
"merchantSignup": {},
"merchantData": {
"basicDetails": {
"id": "64********c7",
"name": "..name..",
"email": "..email..",
"mobile": "..mobile..",
"username": "..username..",
"realm": "..realm..",
"applicationId": "62*******94",
"distributorId": "62*******31",
"isDeleted": false,
"backopsUserId": "",
"realmId": "62********94",
"signzyAppId": "dh********25",
"autogeneratedUsername": true,
"regex": "",
"onboardingStartDate": 1690983052861,
"status": "pending",
"flowDetails": {
"name": "..name..",
"type": "..type.."
},
"autoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl********FjNQ",
"loginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortLoginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortAutoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl**********FjNQ",
"eventSource": "webapp",
"eventStatus": "onboardingCompleted",
"initialSubmissionDate": 1690983191120,
"onboardingEndDate": 1690983191120,
"subStatus": "allKYCDone",
"decisionEngineResult": "uncertain",
"internalNotes": [],
"backopsUserDetails": {}
},
"documents": [
{
"AadhaarImage1": "File URL",
"AadhaarName": "Name",
"AadhaarUid": "Uid",
"AadhaarVid": "Vid",
"AadhaarDob": "Date Of Birth",
"AadhaarYob": "Year Of Birth",
"AadhaarPincode": "Pincode",
"AadhaarAddress": "Address",
"AadhaarGender": "Gender",
"AadhaarUidHash": "UID Hash",
"Aadhaarstate": "State",
"Aadhaardistrict": "District",
"Aadhaarcity": "City",
"Aadhaarcountry": "Country",
"type": "Digilocker Aadhaar",
"widgetName": "Digilocker Aadhaar"
},
{
"PANtoGSTApplicationStatus": "Application Status",
"PANtoGSTRegistrationName": "Registration Name",
"PANtoGSTMobNum": "Mobile Number",
"PANtoGSTRegType": "Registration Type",
"PANtoGSTEmailId": "Email Id",
"PANtoGSTTinNumber": "Tin Number",
"PANtoGSTGstinRefId": "Gstin RefId",
"PANtoGSTGstin": "Gstin",
"PANtoGSTConstitutionOfBusiness": "Constitution Of Business",
"PANtoGSTLegalNameOfBusiness": "Legal Name Of Business",
"PANtoGSTTradeNameOfBusiness": "Trade Name Of Business",
"PANtoGSTCentreJurisdiction": "Centre Jurisdiction",
"PANtoGSTStateJurisdiction": "State Jurisdiction",
"PANtoGSTRegistrationDate": "Registration Date",
"PANtoGSTTaxPayerDate": "Tax Payer Date",
"PANtoGSTTaxPayerType": "Tax Payer Type",
"PANtoGSTGstinStatus": "Gstin Status",
"PANtoGSTCancellationDate": "Cancellation Date",
"PANtoGSTNatureOfBusinessActivities": "Nature Of Business Activities",
"PANtoGSTPrincipalPlaceAddress": "Principal Place Address",
"PANtoGSTPrincipalPlaceLatitude": "Principal Place Latitude",
"PANtoGSTPrincipalPlaceLongitude": "Principal Place Longitude",
"PANtoGSTPrincipalPlaceBuildingNameFromGST": "Principal Place Building Name From GST",
"PANtoGSTPrincipalPlaceBuildingNoFromGST": "Principal Place Building No From GST",
"PANtoGSTPrincipalPlaceFlatNo": "Principal Place Flat No",
"PANtoGSTPrincipalPlaceStreet": "Principal Place Street",
"PANtoGSTPrincipalPlaceLocality": "Principal Place Locality",
"PANtoGSTPrincipalPlaceCity": "Principal Place City",
"PANtoGSTPrincipalPlaceDistrict": "Principal Place District",
"PANtoGSTPrincipalPlaceState": "Principal Place State",
"PANtoGSTPrincipalPlacePincode": "Principal Place Pincode",
"PANtoGSTAdditionalPlaceAddress": "Additional Place Address",
"PANtoGSTAdditionalPlaceLatitude": "Additional Place Latitude",
"PANtoGSTAdditionalPlaceLongitude": "Additional Place Longitude",
"PANtoGSTAdditionalPlaceBuildingNameFromGST": "Additional Place Building Name From GST",
"PANtoGSTAdditionalPlaceBuildingNoFromGST": "Additional Place Building No From GST",
"PANtoGSTAdditionalPlaceFlatNo": "Additional Place Flat No",
"PANtoGSTAdditionalPlaceStreet": "Additional Place Street",
"PANtoGSTAdditionalPlaceLocality": "Additional Place Locality",
"PANtoGSTAdditionalPlaceCity": "Additional Place City",
"PANtoGSTAdditionalPlaceDistrict": "Additional Place District",
"PANtoGSTAdditionalPlaceState": "Additional Place State",
"PANtoGSTAdditionalPlacePincode": "Additional Place Pincode",
"type": "PAN to GST",
"widgetName": "PAN to GST"
},
{
"BusinessPanImage": "File URL",
"BusinessPanName": "Name",
"BusinessPanDateOfIssue": "Date Of Issue",
"BusinessPanPanNumber": "Pan Number",
"type": "Business PAN",
"widgetName": "Business PAN"
}
],
"formData": {
"address": "Aadhaaraddress",
"adhaaradress": "Aadhaar address",
"gstaddress": "GST address",
"enteraddress": "Enter Address",
"widgetName": "Manual Data Entry"
},
"videoForensics": {
"audioMatchScore": "Audio Match Score",
"videoMatchScore": "Video Match Score",
"videoCoVariance": "video CoVariance",
"videoFinalImage": "https://preproduction-persist.signzy.tech/api/files/3***3/download/image.jpg",
"videoUrl": "https://preproduction-persist.signzy.tech/api/files/3***3/download/image.jpg",
"videoOtp": "https://preproduction-persist.signzy.tech/api/files/3***3/download/image.jpg",
"videoFaceLandmark": "Video Face Landmark Image URL",
"videoPrerecordedRisk": "Video Pre-recorded Risk",
"videoStaticRisk": "video Static Risk",
"videoLandMark": "Video Landmark",
"type": "Video Verification",
"widgetName": "Video Verification"
},
"videoKyc": [],
"contract": {},
"contractSDK": {},
"products": [],
"data": [],
"browserAndLocationInfo": {},
"appAndLocationInfo": {},
"matcherData": [],
"internalNotes": []
},
"merchantAuditData": [],
"submerchantAuditData": []
}
}
﻿
Response Field Description
Key
Data Type
Description
merchantData
object
This contains all the data of the merchant
basicDetails
object
Contains basic details of the merchant and onboarding
documents
array of objects
Contains data about documents collected in the onboarding
formData
object
Data returned from video KYC and verification
contract
object
Contains data of digital contract
products
string
Realm returned from the backops user login
flowId
array of objects
Contains data of opted products
browserAndLocationInfo
object
Contains data about merchants location and browser
browserInfo
object
Contains browser info
locationInfo
object
Contains location info based on ISP
matcherData
array of objects
Contains data of name match/text match/ address match
signzyAppId
string
Signzy App Id
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
merchantData	object	This contains all the data of the merchant
basicDetails	object	Contains basic details of the merchant and onboarding
documents	array of objects	Contains data about documents collected in the onboarding
formData	object	Data returned from video KYC and verification
contract	object	Contains data of digital contract
products	string	Realm returned from the backops user login
flowId	array of objects	Contains data of opted products
browserAndLocationInfo	object	Contains data about merchants location and browser
browserInfo	object	Contains browser info
locationInfo	object	Contains location info based on ISP
matcherData	array of objects	Contains data of name match/text match/ address match
signzyAppId	string	Signzy App Id
Updated 30 Nov 2023
Did this page help you?
Push Merchant API
Callback API (Partner)