Modules
Partner Ecosystem

Callback API (Partner)

5min

Introduction

The API will allow you to define event-based (accept, reject, pending) callbacks for each partner. These callbacks are where the JSON data will be posted once that event happens.

Sample Request

Preproduction
Curl


Request Field Description

Key

Required/Optional

Data type

Description

Header







Authorization

Required



authorization token

Content-Type

Required

string

application/json

Body







distributorId

Required

string

This is a unique identifier of the partner.

realmId

Required

string

This is an identifier used by the GO platform, the same will be provided by the Signzy team.

flowId

Required

string

Flow that is assigned to the partner.

callbacks

Required

string

The callbacks are widely used to post data based on specific events defined within the GO platform.

Sample Response

JSON


Key

Data Type

Description

id

string

This is your access token to be passed into other endpoints as an Authorization header

name

string

Name of the partner

email

string

Email ID of the partner

mobile

string

Mobile number of the partner

username

string

Username of the partner

flowId

string

Flow that is to be assigned to the partner

realm

string

Realm returned from the login request

applicationId

string

This is a realm identifier, to be given by the Signzy team.

distributorId

string

This is a unique identifier of the partner

backopsUserId

string

User ID for the backops portal

realmId

string

This is an identifier used by the GO platform, the same will be provided by the Signzy team.

signzyAppId

string

This is the reference ID that is used to identify the application

autogeneratedUsername

string

The username can be either created manually or can be auto-generated. This field is true if the username is auto-generated and false if not.

regex

string

If there is any regex impression attached to the username it is shown here.

onboardingStartDate

string

Start date of the onboarding journey

status

string

The current status of the application. By default, this is "New" for a newly created application.

flowDetails

string

Details of the assigned flow

name

string

Name of the flow

type

string

Type of the flow

autoLoginUrl

string

This is the URL where the partner needs to be redirected to commence the onboarding journey.

shortAutoLoginUrl

string

Shortened autologin URL

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].