Integration Guide

Data Level Callbacks

3min

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.

New Link Created


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

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

Application moved to Pending
Application moved to Accepted
Application moved to Rejected
Application moved to Drafted

  1. Application Moved to Pending - The data on the callback(configured) is posted once the application has been submitted to the GO platform.
  2. Application Moved to Accepted - The data on the callback(configured) is posted once the application has been accepted from the GO platform.
  3. Application Moved to Rejected - The data on the callback(configured) is posted once the application has been rejected from the GO platform.
  4. 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

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

  • It indicates the application's status, such as whether it is Pending, Accepted, Rejected, or Drafted.
  • Pending - Once the journey is completed and the maker has completed the call and action is pending on checker.
  • Accepted - Once the application is accepted by Checker/Auditor
  • Rejected - Once the application is rejected by Checker/Auditor
  • Drafted - Once the application is drafted marked as redo by Checker/Auditor

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.

FAQs