Callback Configuration

6min
One program can communicate with another application asynchronously and loosely coupled through a callback URL. Callback URLs are POST API endpoints to a database, where JSON data can be pushed from Signzy’s system. Here, we can customize it under the Bank's supplied URL if we want to push the data of the entire onboarding process to the client's system, such as the Bank's MMS, DMS, etc.
Application Callback
After the completion of the onboarding journey, the status of the application has to be sent to the bank's/NBFC's server. There are multiple triggers(or events) when JSON data of the application can be pushed to the callback URL:
Pending: The data on the callback(configured) is posted when the application is pending﻿ from the GO platform.
Accept: The data on the callback(configured) is posted once the application has been accepted﻿ from the GO platform.
Reject: The data on the callback(configured) is posted once the application has been rejected﻿ from the GO platform.
Draft: The data on the callback(configured) is posted once the application has been drafted﻿ from the GO platform.
DropOff: The data on the callback (configured) is posted when the user is dropped off﻿ from the platform midway through the journey.
These can be configured separately by entering the details in the following fields:
URL: The callback URL for the specific status. (Bank-specified URL)
Authentication Key: The authentication key provided by the client(bank/NBFC) is entered here.
Authentication Value: The authentication value provided by the client(bank/NBFC) is entered here.
Application Callback
﻿
Pending
Accept
Reject
Draft
Drop off
{
  "merchantSignup": {},
  "merchantData": {
    "id": "64*******26",
    "name": "..name..",
    "email": "..email..",
    "mobile": "..mobile..",
    "username": "..username..",
    "flowId": "64******73",
    "realm": "..realm..",
    "applicationId": "62******13",
    "isDeleted": false,
    "createdByBackopsUserId": "62******eb",
    "backopsUserId": "",
    "flowName": "..flow name..",
    "redirectUrl": "",
    "imageurl": "",
    "address23": "",
    "test_dedupe": "",
    "status": "pending",
    "regex": "",
    "autogeneratedUsername": true,
    "onboardingStartDate": 1691676702283,
    "flowDetails": { "name": "..name..", "type": "..type.." },
    "autoLoginUrl": "https://go-preproduction.signzy.app/{realm}/al/UH********Q1",
    "loginUrl": "https://go-preproduction.signzy.app/{realm}/login",
    "shortLoginUrl": "https://s***z/Q***g",
    "shortAutoLoginUrl": "https://s***z/5***o",
    "signzyAppId": 10*****62,
    "lastLoginAt": 1691676702777,
    "lastVisitedPage": { "pageId": "64*****84" },
    "path": "[\"64******34\",\"64******84\"]",
    "previousPageIds": ["64******34", "64******84"],
    "eventSource": "webapp",
    "eventStatus": "onboardingCompleted",
    "initialSubmissionDate": 1691676731226,
    "onboardingEndDate": 1691676731227,
    "subStatus": "allKYCDone",
    "decisionEngineResult": "uncertain",
    "internalNotes": [],
    "createdByBackopsUserName": "GoProduct",
    "data": [
      {
        "id": "64******59",
        "pageId": "64******34",
        "flowId": "64******73",
        "data": {
          "IndividualPanImage": "https://preproduction-persist.signzy.tech/api/files/3****5/download/panimage.jpg",
          "IndividualPanName": "..name..",
          "IndividualPanFatherName": "..father name..",
          "IndividualPanDateOfBirth": "..date of birth..",
          "IndividualPanPanNumber": "..pan number..",
          "type": "Individual Pan",
          "widgetName": "Individual PAN",
          "browserAndLocationInfo": {
            "browserInfo": {
              "browserName": "Chrome",
              "fullVersion": "115.0.0.0",
              "majorVersion": 115,
              "cookiesEnabled": true,
              "browserLanguage": "en-US",
              "platform": true
            },
            "locationInfo": {
              "ip": "..ip..",
              "network": "..network..",
              "version": "..version..",
              "city": "..city..",
              "region": "..region..",
              "region_code": "..region code..",
              "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": "..postal..",
              "latitude": ..latitude..,
              "longitude": ..longitude..,
              "timezone": "Asia/Kolkata",
              "utc_offset": "..utc offset..",
              "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": ..country area..,
              "country_population": 1352617328,
              "asn": "AS24309",
              "org": "..org.."
            }
          }
        },
        "merchantId": "64******26",
        "applicationId": "62******13",
        "path": "[\"64******34\"]",
        "previousPageIds": ["64******34"],
        "selectedWidgetIndex": 0,
        "pageName": "pan fetch test3432321",
        "pageType": "Data&Document",
        "isSubflow": false,
        "lastModified": 1691676728363,
        "documentAuthenticatedOn": 1691676720558,
        "_id": "64******59"
      },
      {
        "id": "64******a1",
        "pageId": "64******84",
        "flowId": "64******73",
        "data": {
          "type": "Aadhaar",
          "widgetName": "Digilocker Aadhaar",
          "browserAndLocationInfo": {
            "browserInfo": {
              "browserName": "Chrome",
              "fullVersion": "115.0.0.0",
              "majorVersion": 115,
              "cookiesEnabled": true,
              "browserLanguage": "en-US",
              "platform": true
            },
            "locationInfo": {
              "ip": "..ip..",
              "network": "..network..",
              "version": "..version..",
              "city": "..city..",
              "region": "..region..",
              "region_code": "..region code..",
              "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": "..postal..",
              "latitude": ..latitude..,
              "longitude": ..longitude..,
              "timezone": "Asia/Kolkata",
              "utc_offset": "..utc offset..",
              "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": "AS24309",
              "org": "..org.."
            }
          }
        },
        "merchantId": "64******26",
        "applicationId": "62******13",
        "path": "[\"64******34\",\"64******84\"]",
        "previousPageIds": [
          "64******34",
          "64******84"
        ],
        "selectedWidgetIndex": 0,
        "pageName": "Proof of Identity for BharatPe",
        "pageType": "Data&Document",
        "isSubflow": false,
        "lastModified": 1691676730897,
        "_id": "64******a1"
      }
    ],
    "backopsUserDetails": [],
    "_id": "64******26"
  },
  "matcherData": [],
  "merchantAuditData": [],
  "submerchantAuditData": []
}
{
  "merchantSignup": {},
  "merchantData": {
    "id": "64*******26",
    "name": "..name..",
    "email": "..email..",
    "mobile": "..mobile..",
    "username": "..username..",
    "flowId": "64******73",
    "realm": "..realm..",
    "applicationId": "62******13",
    "isDeleted": false,
    "createdByBackopsUserId": "62******eb",
    "backopsUserId": "",
    "flowName": "..flow name..",
    "redirectUrl": "",
    "imageurl": "",
    "address23": "",
    "test_dedupe": "",
    "status": "pending",
    "regex": "",
    "autogeneratedUsername": true,
    "onboardingStartDate": 1691676702283,
    "flowDetails": { "name": "..name..", "type": "..type.." },
    "autoLoginUrl": "https://go-preproduction.signzy.app/{realm}/al/UH********Q1",
    "loginUrl": "https://go-preproduction.signzy.app/{realm}/login",
    "shortLoginUrl": "https://s***z/Q***g",
    "shortAutoLoginUrl": "https://s***z/5***o",
    "signzyAppId": 10*****62,
    "lastLoginAt": 1691676702777,
    "lastVisitedPage": { "pageId": "64*****84" },
    "path": "[\"64******34\",\"64******84\"]",
    "previousPageIds": ["64******34", "64******84"],
    "eventSource": "webapp",
    "eventStatus": "onboardingCompleted",
    "initialSubmissionDate": 1691676731226,
    "onboardingEndDate": 1691676731227,
    "subStatus": "allKYCDone",
    "decisionEngineResult": "uncertain",
    "internalNotes": [],
    "createdByBackopsUserName": "GoProduct",
    "data": [
      {
        "id": "64******59",
        "pageId": "64******34",
        "flowId": "64******73",
        "data": {
          "IndividualPanImage": "https://preproduction-persist.signzy.tech/api/files/3****5/download/panimage.jpg",
          "IndividualPanName": "..name..",
          "IndividualPanFatherName": "..father name..",
          "IndividualPanDateOfBirth": "..date of birth..",
          "IndividualPanPanNumber": "..pan number..",
          "type": "Individual Pan",
          "widgetName": "Individual PAN",
          "browserAndLocationInfo": {
            "browserInfo": {
              "browserName": "Chrome",
              "fullVersion": "115.0.0.0",
              "majorVersion": 115,
              "cookiesEnabled": true,
              "browserLanguage": "en-US",
              "platform": true
            },
            "locationInfo": {
              "ip": "..ip..",
              "network": "..network..",
              "version": "..version..",
              "city": "..city..",
              "region": "..region..",
              "region_code": "..region code..",
              "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": "..postal..",
              "latitude": ..latitude..,
              "longitude": ..longitude..,
              "timezone": "Asia/Kolkata",
              "utc_offset": "..utc offset..",
              "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": ..country area..,
              "country_population": 1352617328,
              "asn": "AS24309",
              "org": "..org.."
            }
          }
        },
        "merchantId": "64******26",
        "applicationId": "62******13",
        "path": "[\"64******34\"]",
        "previousPageIds": ["64******34"],
        "selectedWidgetIndex": 0,
        "pageName": "pan fetch test3432321",
        "pageType": "Data&Document",
        "isSubflow": false,
        "lastModified": 1691676728363,
        "documentAuthenticatedOn": 1691676720558,
        "_id": "64******59"
      },
      {
        "id": "64******a1",
        "pageId": "64******84",
        "flowId": "64******73",
        "data": {
          "type": "Aadhaar",
          "widgetName": "Digilocker Aadhaar",
          "browserAndLocationInfo": {
            "browserInfo": {
              "browserName": "Chrome",
              "fullVersion": "115.0.0.0",
              "majorVersion": 115,
              "cookiesEnabled": true,
              "browserLanguage": "en-US",
              "platform": true
            },
            "locationInfo": {
              "ip": "..ip..",
              "network": "..network..",
              "version": "..version..",
              "city": "..city..",
              "region": "..region..",
              "region_code": "..region code..",
              "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": "..postal..",
              "latitude": ..latitude..,
              "longitude": ..longitude..,
              "timezone": "Asia/Kolkata",
              "utc_offset": "..utc offset..",
              "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": "AS24309",
              "org": "..org.."
            }
          }
        },
        "merchantId": "64******26",
        "applicationId": "62******13",
        "path": "[\"64******34\",\"64******84\"]",
        "previousPageIds": [
          "64******34",
          "64******84"
        ],
        "selectedWidgetIndex": 0,
        "pageName": "Proof of Identity for BharatPe",
        "pageType": "Data&Document",
        "isSubflow": false,
        "lastModified": 1691676730897,
        "_id": "64******a1"
      }
    ],
    "backopsUserDetails": [],
    "_id": "64******26"
  },
  "matcherData": [],
  "merchantAuditData": [],
  "submerchantAuditData": []
}
﻿
Page Callback
If we want to send the data of the entire onboarding process- page-wise to the client's admin, such as the Bank's back-end server, we can customize it following the Bank's specified URL here.
These can be configured separately for each page in the journey by entering the details in the following fields:
URL: The callback URL for the specific status. (Bank-specified URL)
Authentication Key: The authentication key provided by the client(bank/NBFC) is entered here.
Authentication Value: The authentication value provided by the client(bank/NBFC) is entered here.
Page Callback
﻿
Response
{
  "path": "[\"62******32\"]",
  "previousPageIds": ["62******32"],
  "selectedWidgetIndex": 0,
  "pageId": "62******32",
  "pageName": "Proof Of Identity",
  "merchantId": "64******aa",
  "applicationId": "62******413",
  "flowId": "63******cc",
  "data": {
    "DrivingLicenseImage1": "https://preproduction-persist.signzy.tech/api/files/3***7/download/1b**********ba.jpg",
    "DrivingLicenseImage2": "",
    "DrivingLicenseName": "..name..",
    "DrivingLicenseIssueDate": "01/03/2011",
    "DrivingLicenseExpiryDate": "08/02/2026",
    "DrivingLicenseDob": "..date of birth..",
    "DrivingLicenseNumber": "..license number..",
    "DrivingLicenseGuardianName": "..guardian name..",
    "DrivingLicenseAddress": "..address.",
    "DrivingLicenseDLType": "",
    "DrivingLicensestate": "..state..",
    "DrivingLicensedistrict": "..district..",
    "DrivingLicensecity": "..city..",
    "DrivingLicensecountry": "..country..",
    "DrivingLicensepincode": "..pincode..",
    "documentAuthenticatedOn": 1692022901604,
    "type": "Driving License",
    "widgetName": "Driving License",
    "browserAndLocationInfo": {
      "browserInfo": {
        "browserName": "Chrome",
        "fullVersion": "115.0.0.0",
        "majorVersion": 115,
        "cookiesEnabled": true,
        "browserLanguage": "en-US",
        "platform": true
      },
      "locationInfo": {
        "ip": "..ip..",
        "network": "..network..",
        "version": "..version..",
        "city": "..city..",
        "region": "..region..",
        "region_code": "..region code..",
        "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": "..postal..",
        "latitude": ..latitude..,
        "longitude": ..longitude..,
        "timezone": "Asia/Kolkata",
        "utc_offset": "..utc offset..",
        "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": "AS17488",
        "org": "..org.."
      }
    }
  },
  "pageType": "Data&Document",
  "isSubflow": false
}
{
  "path": "[\"62******32\"]",
  "previousPageIds": ["62******32"],
  "selectedWidgetIndex": 0,
  "pageId": "62******32",
  "pageName": "Proof Of Identity",
  "merchantId": "64******aa",
  "applicationId": "62******413",
  "flowId": "63******cc",
  "data": {
    "DrivingLicenseImage1": "https://preproduction-persist.signzy.tech/api/files/3***7/download/1b**********ba.jpg",
    "DrivingLicenseImage2": "",
    "DrivingLicenseName": "..name..",
    "DrivingLicenseIssueDate": "01/03/2011",
    "DrivingLicenseExpiryDate": "08/02/2026",
    "DrivingLicenseDob": "..date of birth..",
    "DrivingLicenseNumber": "..license number..",
    "DrivingLicenseGuardianName": "..guardian name..",
    "DrivingLicenseAddress": "..address.",
    "DrivingLicenseDLType": "",
    "DrivingLicensestate": "..state..",
    "DrivingLicensedistrict": "..district..",
    "DrivingLicensecity": "..city..",
    "DrivingLicensecountry": "..country..",
    "DrivingLicensepincode": "..pincode..",
    "documentAuthenticatedOn": 1692022901604,
    "type": "Driving License",
    "widgetName": "Driving License",
    "browserAndLocationInfo": {
      "browserInfo": {
        "browserName": "Chrome",
        "fullVersion": "115.0.0.0",
        "majorVersion": 115,
        "cookiesEnabled": true,
        "browserLanguage": "en-US",
        "platform": true
      },
      "locationInfo": {
        "ip": "..ip..",
        "network": "..network..",
        "version": "..version..",
        "city": "..city..",
        "region": "..region..",
        "region_code": "..region code..",
        "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": "..postal..",
        "latitude": ..latitude..,
        "longitude": ..longitude..,
        "timezone": "Asia/Kolkata",
        "utc_offset": "..utc offset..",
        "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": "AS17488",
        "org": "..org.."
      }
    }
  },
  "pageType": "Data&Document",
  "isSubflow": false
}
﻿
Email
It can be configured if a mail is required in case a callback fails. This can be done by clicking on the 'Mail required' toggle. The email ID(s) on which the mail will be sent is entered(comma-separated list of email IDs or a single email ID).
Email Callback Configuration
﻿
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].
﻿
Updated 11 Oct 2024
Did this page help you?
Triggering Dedupe on Any Textbox in the Journey
Custom Backops Form