Integration Guide

Pull Merchant API

5min

Introduction

The Pull API is used for fetching the data from the GO platform. The API helps to get all the details appended to the application after verification, validation or any other operation performed within the platform.

The API also helps determine the status of the application within the Platform.

Sample Curl

Preproduction
Sample cURL


Request Field Description

Key

Required/Optional

Data Type

Description

Authorization

Required

string

The token is generated during step-1 - login

Sample Response

200: OK
400: Bad Request
401: Unauthorized
404: Not Found


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, or Rejected.

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.