Data Level Callbacks
3 min
There are two types of Callbacks that we send one is Data Level Callbacks and another is Event Level Callbacks.
There are four major data callback events whose responses are described below.
{
"merchantData": {
"id": "669a08a04a33990018c55d30",
"name": "Bot",
"email": "[email protected]",
"mobile": "9999999999",
"realm": "Client_Name",
"applicationId": "667d51ce4994ff24f5bbed75",
"dob": "6/2/2000",
"permanentAddress": "Krishna, Andhrapradesh, 521121",
"currentAddress": "BTM Layout, Bengaluru, Karnataka, 500076",
"aadhaarFrontImage": "https://preproduction-persist.signzy.tech/api/files/41562538/download/6f10536539a743d2afe761e4cxxxxxxxxx.jpeg",
"aadhaarBackImage": "https://preproduction-persist.signzy.tech/api/files/41562548/download/0883bbeca3d54a3f859474fa6a9bab6a9ae57ac7801049758c8axxxxxxxxx.jpeg",
"panCardImage": "https://preproduction-persist.signzy.tech/api/files/41562561/download/ca40bfab2f9b45d194258b461ba3cbde2066c37e29f540b7868acxxxxxxxxx.jpg",
"flowName": "VKYC Journey",
"requestID": "001",
"status": "new",
"flowDetails": {
"name": "VKYC Journey",
"type": "mainflow"
},
"autoLoginUrl": "https://go-preproduction.signzy.app/ClientName_VCIP/al/VmVnYVBheTo3YzEwOxxxxxxxxx",
"signzyAppId": 1000212
}
}Key | Description |
|---|---|
id | Unique ID of the customer/merchant |
status | The current status of the application. By default, this is "New" for a newly created application |
name | Name for the end user whose onboarding needs to be conducted |
Email for the end user whose onboarding needs to be conducted | |
mobile | Phone for the end user whose onboarding needs to be conducted |
realm | Realm returned from the backops user login |
flowName | It can have multiple flows in a specific realm, and this flowName represents the actual flow assigned to the end user. |
autoLoginUrl | This is the URL where the merchant needs to be redirected to commence the onboarding journey. |
signzyAppId | This is the reference ID that is used to identify the application |
{
"merchantSignup": {},
"merchantData": {
"id": "6699f6cd5c477b10d8901a2d",
"name": "Bot",
"email": "[email protected]",
"mobile": "9xxxxxxxxx",
"username": "8ec4091a",
"flowId": "667d586b90129f001746448c",
"realm": "Client_Name",
"applicationId": "667d51ce4994ff24f5bbed75",
"isDeleted": false,
"backopsUserId": "668be86b8163e40415991b9b",
"dob": "6/2/2000",
"permanentAddress": "Krishna, Andhrapradesh, 521121",
"currentAddress": "BTM Layout, Bengaluru, Karnataka, 500076",
"aadhaarFrontImage": "https://preproduction-persist.signzy.tech/api/files/41562538/download/6f10536539a743d2afe761e4c9f247a3a477709bcd1944c8bxxxxxxxxx.jpeg",
"aadhaarBackImage": "https://preproduction-persist.signzy.tech/api/files/41562548/download/0883bbeca3d54a3f859474fa6a9bab6a9ae57ac7801049758cxxxxxxxxx.jpeg",
"panCardImage": "https://preproduction-persist.signzy.tech/api/files/41562561/download/ca40bfab2f9b45d194258b461ba3cbde2066c37e29f540b7868ac3bxxxxxxxxx.jpg",
"flowName": "VKYC Journey",
"requestID": "001",
"redirectUrl": "https://www.Client_Name.tech/",
"autogeneratedUsername": true,
"regex": "",
"onboardingStartDate": 1721366235808,
"status": "draft",
"flowDetails": {
"name": "VKYC Journey",
"type": "mainflow"
},
"autoLoginUrl": "https://go-preproduction.signzy.app/Client_Name/al/VmVnYVBheTo4ZWM0MDkxYSYmMxxxxxxxxx",
"loginUrl": "https://go-preproduction.signzy.app/Client_Name/login",
"shortLoginUrl": "https://go-preproduction.signzy.app/Client_Name/login",
"shortAutoLoginUrl": "https://go-preproduction.signzy.app/Client_Name/al/VmVnYVBheTo4ZWM0MDkxYSxxxxxxxxx",
"signzyAppId": 1000207,
"lastLoginAt": 1721366235054,
"lastVisitedPage": null,
"path": "[\"667d586b90129f001746448b\",\"667d586b90129f001746448a\"]",
"previousPageIds": [],
"callbacksTrail": [
{
"type": "vcip",
"userId": "6699f6cd5c477b10d8901a2d",
"isSubflow": "false",
"token": "",
"date": 1721366342864
}
],
"waitingForCallback": false,
"eventSource": "webapp",
"eventStatus": "onboardingCompleted",
"initialSubmissionDate": 1721366354839,
"onboardingEndDate": 1721366354839,
"subStatus": "notEscalated",
"decisionEngineResult": "uncertain",
"designation": "",
"actionBy": "Client_Name123",
"actionTime": 1721373258788,
"backopsUser": {
"id": "668be86b8163e40415991b9b",
"name": "Client_Name",
"username": "Client_Name123",
"email": "[email protected]",
"password": "$2b$10$ZWtTJ656oQ/jAd52jUIvJO5t2WcByiq5fefMLb/g9O8U8b3xVUpqa",
"mobile": "9876543210",
"realm": "Client_Name",
"isDormant": false,
"applicationId": "667d51ce4994ff24f5bbed75",
"managerToggle": "false",
"manager": "",
"managerName": "",
"profileSettings": null,
"jobTimestamp": null,
"employeeCode": "321",
"applicationQueueViews": null,
"designationId": "668be8110cc5b8001770eded",
"branch": "BTM",
"flowIds": [
"667d586b90129f001746448c"
],
"active": true,
"lowestLevel": true,
"lastUpdatedAt": 1720445035782,
"assignment": {
"count": 0,
"actionTaken": 0
},
"invalidLoginAttempt": 0,
"invalidLoginAttemptSession": null,
"lastLoginAt": 1721365987993,
"passwordLastModifiedOn": 1720445125762,
"lastLogoutAt": 1721305281501
},
"contractSigned": false,
"draftsCount": 1,
"instructions": "Insufficient Data",
"priority": null,
"reason": "Insufficient Data",
"internalNotes": [
{
"id": "6699f7525c477b10d8901a35",
"message": {
"instructions": "",
"subject": "submission",
"reason": ""
},
"logTime": "2024-07-19T05:19:14.839Z",
"type": "logs",
"merchantId": "6699f6cd5c477b10d8901a2d",
"action": "submitted",
"actionBy": "Bot",
"designation": "",
"_id": "6699f7525c477b10d8901a35"
},
{
"id": "6699f752f5152d10d22adcb0",
"message": {
"instructions": "",
"subject": "Auto assign",
"reason": ""
},
"logTime": "2024-07-19T05:19:14.970Z",
"type": "logs",
"merchantId": "6699f6cd5c477b10d8901a2d",
"action": "auto-assign",
"actionBy": "Client_Name",
"designation": "",
"_id": "6699f752f5152d10d22adcb0"
},
{
"id": "669a124a51ddd800848c0dea",
"message": {
"instructions": "Insufficient Data",
"subject": "draft",
"reason": "Insufficient Data",
"configuredKeys": {}
},
"logTime": "2024-07-19T07:14:18.232Z",
"type": "logs",
"merchantId": "6699f6cd5c477b10d8901a2d",
"action": "draft",
"actionBy": "Client_Name123",
"designation": "Backops User",
"actionTab": "summary",
"backopsUserId": "668be86b8163e40415991b9b",
"_id": "669a124a51ddd800848c0dea"
}
],
"data": [
{
"id": "6699f6dff5152d10d22adca5",
"pageId": "667d586b90129f001746448b",
"flowId": "667d586b90129f001746448c",
"data": {
"AadhaarFront": "https://preproduction-persist.signzy.tech/api/files/41562538/download/6f10536539a743d2afe761e4c9f247a3a477709bcd1944c8be65xxxxxxxxx.jpeg",
"aadhaarBackImage": "https://preproduction-persist.signzy.tech/api/files/41562548/download/0883bbeca3d54a3f859474fa6a9bab6a9ae57ac7801049758xxxxxxxxx.jpeg",
"PanImage": "https://preproduction-persist.signzy.tech/api/files/41562561/download/ca40bfab2f9b45d194258b461ba3cbde2066c37e29f540b7868axxxxxxxxx.jpg",
"name": "Bot",
"email": "[email protected]",
"dob": "6/2/2000",
"permanentAddress": "Krishna, Andhrapradesh, 521121",
"currentAddress": "",
"type": "Manual Data Entry 2",
"widgetName": "Manual Data Entry 2",
"browserAndLocationInfo": {
"browserInfo": {
"browserName": "Chrome",
"fullVersion": "126.0.0.0",
"majorVersion": 126,
"cookiesEnabled": true,
"browserLanguage": "en-GB",
"platform": true
},
"locationInfo": {
"ip": "223.185.133.176",
"network": "223.185.128.0/20",
"version": "IPv4",
"city": "Bengaluru",
"region": "Karnataka",
"region_code": "KA",
"country": "IN",
"country_name": "India",
"country_code": "IN",
"country_code_iso3": "IND",
"country_capital": "New Delhi",
"country_tld": ".in",
"continent_code": "AS",
"in_eu": false,
"postal": "560076",
"latitude": 12.9634,
"longitude": 77.5855,
"timezone": "Asia/Kolkata",
"utc_offset": "+0530",
"country_calling_code": "+91",
"currency": "INR",
"currency_name": "Rupee",
"languages": "en-IN,hi,bn,te,mr,ta,ur,gu,kn,ml,or,pa,as,bh,sat,ks,ne,sd,kok,doi,mni,sit,sa,fr,lus,inc",
"country_area": 3287590,
"country_population": 1352617328,
"asn": "AS24560",
"org": "Bharti Airtel Ltd., Telemedia Services"
}
}
},
"merchantId": "6699f6cd5c477b10d8901a2d",
"applicationId": "667d51ce4994ff24f5bbed75",
"path": "[\"667d586b90129f001746448b\"]",
"previousPageIds": [
"667d586b90129f001746448b"
],
"selectedWidgetIndex": 0,
"pageName": "Instruction Page - VKYC",
"pageType": "Manual Data Entry 2",
"isSubflow": false,
"handoffFrom": "Merchant",
"lastModified": 1721366239334,
"_id": "6699f6dff5152d10d22adca5"
},
{
"id": "6699f6e15c477b10d8901a31",
"pageId": "667d586b90129f001746448a",
"flowId": "667d586b90129f001746448c",
"data": {
"browserAndLocationInfo": {
"browserInfo": {
"browserName": "Chrome",
"fullVersion": "126.0.0.0",
"majorVersion": 126,
"cookiesEnabled": true,
"browserLanguage": "en-GB",
"platform": true
},
"locationInfo": {
"ip": "223.185.133.176",
"network": "223.185.128.0/20",
"version": "IPv4",
"city": "Bengaluru",
"region": "Karnataka",
"region_code": "KA",
"country": "IN",
"country_name": "India",
"country_code": "IN",
"country_code_iso3": "IND",
"country_capital": "New Delhi",
"country_tld": ".in",
"continent_code": "AS",
"in_eu": false,
"postal": "560076",
"latitude": 12.9634,
"longitude": 77.5855,
"timezone": "Asia/Kolkata",
"utc_offset": "+0530",
"country_calling_code": "+91",
"currency": "INR",
"currency_name": "Rupee",
"languages": "en-IN,hi,bn,te,mr,ta,ur,gu,kn,ml,or,pa,as,bh,sat,ks,ne,sd,kok,doi,mni,sit,sa,fr,lus,inc",
"country_area": 3287590,
"country_population": 1352617328,
"asn": "AS24560",
"org": "Bharti Airtel Ltd., Telemedia Services"
}
},
"isVideoProcessing": false,
"callStatus": "",
"appAndLocationInfo": null,
"vcipErrorCode": null,
"adminDetails": {
"username": "bot12",
"email": "[email protected]",
"name": "Bot",
"phone": "9876543210"
},
"browserData": {
"browserName": "Chrome",
"cookieEnabled": "true",
"browserLanguage": "en-GB",
"os": "GNU/Linux",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
"pluginsInstalled": [
"PDF Viewer",
"Chrome PDF Viewer",
"Chromium PDF Viewer",
"Microsoft Edge PDF Viewer",
"WebKit built-in PDF"
],
"screenWidth": "1920",
"screenHeight": "1080",
"screenPixelDepth": "24",
"screenColorDepth": "24",
"deviceInfo": {
"is_mobile": false,
"complete_device_name": " ",
"form_factor": "desktop",
"os": {
"name": "GNU/Linux",
"version": "",
"platform": "x64"
}
},
"browserVersion": "126.0"
},
"callDuration": {
"startTime": 1721366298994,
"endTime": 1721366318547
},
"callbackStatus": "successful",
"documents": [
{
"pageId": "667d586b90129f001746448b",
"data": {
"Name": "Bot",
"Email": "[email protected]",
"Date Of Birth": "6/2/2000",
"Permanent Address": "Krishna, Andhrapradesh, 521121"
},
"images": [
"https://preproduction-persist.signzy.tech/api/files/41562538/download/6f10536539a743d2afe761e4c9f247a3a477709bcd1944c8be653xxxxxxxxx.jpeg",
"https://preproduction-persist.signzy.tech/api/files/41562561/download/ca40bfab2f9b45d194258b461ba3cbde2066c37e29f540b7868axxxxxxxxx.jpg"
],
"image": "https://preproduction-persist.signzy.tech/api/files/41562561/download/ca40bfab2f9b45d194258b461ba3cbde2066c37e29f540b7868xxxxxxxxx.jpg",
"useForFaceMatch": true,
"documentExpiry": "",
"widgetName": "Manual Data Entry 2"
}
],
"email": "[email protected]",
"eventLogs": {
"events": [],
"error": "reportInitiationId not found!"
},
"fieldValues": {
"Remark": "Successful call"
},
"forenseicsData": {
"ip": "164.52.196.75",
"country_code": "IN",
"country_name": "INDIA",
"city": "FARIDABAD",
"block": 1,
"zipCode": "121005",
"timezone": "IST, Asia/Kolkata",
"state": "HARYANA",
"stateCode": "HR"
},
"geo": {
"countryName": "INDIA",
"shortName": "IN",
"complete": "1ST RIGHT CROSS, THOMAS LAYOUT MAIN RD, THOMAS LAYOUT HADO SIDDAPURA, DODDAKANNELLI, BENGALURU, KARNATAKA 560035, INDIA",
"city": "BENGALURU",
"zipCode": "560035",
"state": "KARNATAKA",
"stateCode": "KA",
"regionName": "KARNATAKA",
"ipAddress": "164.52.196.75",
"latitude": "12.9007616",
"longitude": "77.6994816"
},
"inFlowSummary": [
{
"imageTaken": "",
"facematchScore": "",
"question": "Please show your PAN card to the camera?"
},
{
"imageTaken": "",
"facematchScore": "",
"question": "What is your name?"
},
{
"imageTaken": "",
"facematchScore": "",
"question": "What is your Date of Birth?"
},
{
"imageTaken": "",
"facematchScore": "",
"question": "Please show your signature to the camera ?"
},
{
"imageTaken": "",
"facematchScore": "",
"question": "Please be steady infront of camera to capture photo ?"
},
{
"imageTaken": "",
"facematchScore": "",
"question": "Which state do you reside in?"
}
],
"instructions": [
{
"isIDCardBoxRequired": true,
"isSideNavRequired": false,
"isScreenshotRequired": true,
"isFaceMatchRequired": false,
"text": "Please show your PAN card to the camera?",
"enableScreenshot": true,
"isInstructionMandatory": false,
"translations": {
"ENGLISH": "Please show your PAN card to the camera?",
"HINDI": "कृपया अपना पैन कार्ड कैमरे को दिखाएं?",
"KANNADA": "ದಯವಿಟ್ಟು ನಿಮ್ಮ ಪ್ಯಾನ್ ಕಾರ್ಡ್ ಅನ್ನು ಕ್ಯಾಮರಾಗೆ ತೋರಿಸುವುದೇ?",
"BENGALI": "ক্যামেরায় আপনার প্যান কার্ড দেখাবেন?",
"GUJARATI": "કૃપા કરીને કેમેરાને તમારું પાન કાર્ડ બતાવો?"
}
},
{
"isIDCardBoxRequired": false,
"isSideNavRequired": false,
"isFaceMatchRequired": false,
"isScreenshotRequired": true,
"text": "What is your name?",
"enableScreenshot": false,
"translations": {
"ENGLISH": "What is your name?",
"HINDI": "आपका क्या नाम है?",
"KANNADA": "ನಿನ್ನ ಹೆಸರೇನು?",
"BENGALI": "আপনার নাম কি?",
"GUJARATI": "તમારું નામ શું છે?"
},
"isInstructionMandatory": false
},
{
"isIDCardBoxRequired": false,
"isSideNavRequired": false,
"isScreenshotRequired": false,
"isFaceMatchRequired": false,
"text": "What is your Date of Birth?",
"enableScreenshot": false,
"translations": {
"ENGLISH": "What is your Date of Birth?",
"HINDI": "आपकी जन्म तिथि क्या है?",
"KANNADA": "ನಿಮ್ಮ ಹುಟ್ಟಿದ ದಿನಾಂಕ ಯಾವುದು?",
"BENGALI": "তোমার জন্মদিন কবে?",
"GUJARATI": "તમારી જન્મ તારીખ શું છે?"
},
"isInstructionMandatory": false
},
{
"isIDCardBoxRequired": true,
"isSideNavRequired": false,
"enableScreenshot": true,
"text": "Please show your signature to the camera ?",
"translations": {
"ENGLISH": "Please show your signature to the camera ?",
"HINDI": "कृपया कैमरे के सामने अपना हस्ताक्षर दिखाएं?",
"KANNADA": "ದಯವಿಟ್ಟು ನಿಮ್ಮ ಸಹಿಯನ್ನು ಕ್ಯಾಮರಾಗೆ ತೋರಿಸುವುದೇ?",
"BENGALI": "ক্যামেরায় আপনার স্বাক্ষর দেখান?",
"GUJARATI": "કૃપા કરીને કેમેરાને તમારી સહી બતાવો?"
}
},
{
"isIDCardBoxRequired": false,
"isSideNavRequired": false,
"enableScreenshot": true,
"text": "Please be steady infront of camera to capture photo ?",
"isFaceMatchRequired": false,
"translations": {
"ENGLISH": "Please be steady infront of camera to capture photo ?",
"HINDI": "कृपया फोटो खींचने के लिए कैमरे के सामने स्थिर रहें?",
"KANNADA": "ಫೋಟೋ ಸೆರೆಹಿಡಿಯಲು ದಯವಿಟ್ಟು ಕ್ಯಾಮೆರಾದ ಮುಂದೆ ಸ್ಥಿರವಾಗಿರಿ?",
"BENGALI": "ছবি তোলার জন্য ক্যামেরার সামনে স্থির থাকুন?",
"GUJARATI": "ફોટો લેવા માટે કૃપા કરીને કેમેરાની સામે સ્થિર રહો?"
},
"isInstructionMandatory": false,
"isFeedbackRequired": false,
"feedbackFields": [
{
"elementType": "inputField",
"isRequired": false,
"conditionalRendering": false,
"optionalValuesRequired": false
}
]
},
{
"isIDCardBoxRequired": false,
"isSideNavRequired": false,
"enableScreenshot": false,
"text": "Which state do you reside in?",
"translations": {
"ENGLISH": "Which state do you reside in?",
"HINDI": "आप किस राज्य में रहते हैं?",
"KANNADA": "ನೀವು ಯಾವ ರಾಜ್ಯದಲ್ಲಿ ವಾಸಿಸುತ್ತೀರಿ?",
"BENGALI": "আপনি কোন রাজ্যে থাকেন?",
"GUJARATI": "તમે કયા રાજ્યમાં રહો છો?"
}
}
],
"misData": {
"name": "Bot",
"email": "[email protected]",
"dob": "6/2/2000",
"permanentAddress": "Krishna, Andhrapradesh, 521121",
"faceMatchScore": 0,
"startTime": "2024-07-19T10:48:18.994Z",
"endTime": "2024-07-19T10:48:38.547Z",
"consentText": "Make sure you are suitably qualified to take informed consent for this particular procedure.",
"consentTimestamp": null,
"consentRequired": false
},
"screenshots": [
{
"finalImage": "",
"screenshots": [],
"skipped": true
},
{
"finalImage": "",
"screenshots": []
},
{
"finalImage": "",
"screenshots": []
},
{
"finalImage": "",
"screenshots": [],
"skipped": true
},
{
"finalImage": "",
"screenshots": [],
"skipped": true
},
{
"finalImage": "",
"screenshots": []
}
],
"type": "VCIP",
"unassistedJourneyData": {},
"videoUrl": "https://persist-vkyc-preproduction.signzy.app/api/files/3683995/download/0ad63ca035ba41309dc4xxxxxxxxxxxxxxxxxx.mp4"
},
"merchantId": "6699f6cd5c477b10d8901a2d",
"applicationId": "667d51ce4994ff24f5bbed75",
"path": "[\"667d586b90129f001746448b\",\"667d586b90129f001746448a\"]",
"previousPageIds": [
"667d586b90129f001746448b"
],
"selectedWidgetIndex": 0,
"pageName": "VCIP - VKYC",
"pageType": "VCIP",
"isSubflow": false,
"handoffFrom": "Merchant",
"lastModified": 1721366320136,
"identifier": "01J34PRQ991ZRF5MW6KGBQXCHQ",
"_id": "6699f6e15c477b10d8901a31"
}
],
"backopsUserDetails": [
{
"id": "668be86b8163e40415991b9b",
"name": "Client_Name",
"username": "Client_Name123",
"email": "[email protected]",
"mobile": "9876543210",
"realm": "Client_Name",
"isDormant": false,
"applicationId": "667d51ce4994ff24f5bbed75",
"managerToggle": "false",
"manager": "",
"managerName": "",
"employeeCode": "321",
"designationId": "668be8110cc5b8001770eded",
"branch": "BTM",
"flowIds": [
"667d586b90129f001746448c"
],
"active": true,
"lowestLevel": true,
"lastUpdatedAt": 1720445035782,
"assignment": {
"count": 0,
"actionTaken": 0
},
"invalidLoginAttempt": 0,
"invalidLoginAttemptSession": null,
"lastLoginAt": 1721365987993,
"passwordLastModifiedOn": 1720445125762,
"lastLogoutAt": 1721305281501,
"_id": "668be86b8163e40415991b9b"
}
],
"_id": "6699f6cd5c477b10d8901a2d"
},
"matcherData": [],
"merchantAuditData": [],
"submerchantAuditData": []
}
- Application Moved to Pending - The data on the callback(configured) is posted once the application has been submitted to the GO platform.
- Application Moved to Accepted - The data on the callback(configured) is posted once the application has been accepted from the GO platform.
- Application Moved to Rejected - The data on the callback(configured) is posted once the application has been rejected from the GO platform.
- Application Moved to Drafted - The data on the callback(configured) is posted once the application has been drafted from the GO platform.
Key | Description |
|---|---|
id | Unique ID of the end user |
name | Name for the end user whose onboarding needs to be conducted |
Email for the end user whose onboarding needs to be conducted | |
mobile | Phone for the end user whose onboarding needs to be conducted |
flowId | Flow that is to be assigned to the end user |
realm | Realm returned from the backops user login |
applicationId | This is a realm identifier, to be given by the Signzy team. |
flowName | It can have multiple flows in a specific realm, and this flowName represents the actual flow assigned to the end user. |
redirectUrl | Once the user completes the journey, they will be redirected to a specified website. (Ex: client's website) |
status |
|
finalImage | This is the screenshot of the image finalized by the maker/agent during the Video KYC for that particular question. |
videoUrl | This is the complete video showing interactions between the maker/agent and the end user during Video KYC. |
misData | The misData, including user interaction logs, error reports, and session metadata, is systematically recorded and securely stored here for detailed analysis and optimization of the system’s performance. |
browserData | The details of the browser used during the journey, including the browser type, version, operating system, and any relevant plugins or extensions, are meticulously recorded and stored here for analysis. |
geo | The details of the location where the end user initiated and completed the journey, including geographic coordinates, time zone, and any relevant regional data, are captured and stored here for analysis. |
adminDetails | The maker/agent details are recorded and stored here. |
fieldValues | The "Remark" variable in "fieldValues" stores the remarks provided by the agent or maker. |