Partner Create Merchant API

5min

Introduction
The API is used to create an application instance within our platform and this is created within a realm for a particular flow. The API response will provide an identification of the application within the realm. (The response contains the "merchant id" and "signzyAppId" which can be used as a unique identifier of the application within the platform.)
Sample Request
Preproduction
Curl
curl --location 'https://go-preproduction.signzy.app/api/distributors/createMerchant' \
--header 'Content-Type: application/json' \
--header 'Authorization: ey*********NLEEzM6jBCL8' \
--data-raw '{
    "realmId": "62*******94",
    "realm": "..realm..",
    "name": "..name..",
    "email": "..email..",
    "mobile": "..mobile..",
    "flowId": "62********56",
    "signzyAppId":"dh********25"
}'
curl --location 'https://go-preproduction.signzy.app/api/distributors/createMerchant' \
--header 'Content-Type: application/json' \
--header 'Authorization: ey*********NLEEzM6jBCL8' \
--data-raw '{
    "realmId": "62*******94",
    "realm": "..realm..",
    "name": "..name..",
    "email": "..email..",
    "mobile": "..mobile..",
    "flowId": "62********56",
    "signzyAppId":"dh********25"
}'
﻿
Request Field Description
Key
Required/Optional
Data Type
Description
Header
﻿
﻿
﻿
Content-Type
Required
string
application/json
Authorization
Required
string
authorization token
Body
﻿
﻿
﻿
realmId
Required
string
This is an identifier used by the GO platform, the same will be provided by the Signzy team.
realm
Required
string
Realm returned from the login request
name
Required
string
Name of the partner
email
Required
string
Email ID of the partner
mobile 
Required
string
Mobile number of the partner
flowId
Required
string
Flow that is assigned to the partner
signzyAppId
Required
string
This is the reference ID that is used to identify the application
Sample Response
JSON
{
"id": "64********c7",
"name": "..name..",
"email": "..email..",
"mobile": "..mobile..",
"username": "..username..",
"flowId": "62********56",
"realm": "..realm..",
"applicationId": "62********94",
"distributorId": "62********31",
"backopsUserId": "",
"realmId": "62********94",
"signzyAppId": "dh*********25",
"autogeneratedUsername": true,
"regex": "",
"onboardingStartDate": 1690983052861,
"status": "new",
"flowDetails": {
"name": "..flowname..",
"type": "..type.."
},
"autoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl*********FjNQ",
"loginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortLoginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortAutoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl********FjNQ"
}
{
"id": "64********c7",
"name": "..name..",
"email": "..email..",
"mobile": "..mobile..",
"username": "..username..",
"flowId": "62********56",
"realm": "..realm..",
"applicationId": "62********94",
"distributorId": "62********31",
"backopsUserId": "",
"realmId": "62********94",
"signzyAppId": "dh*********25",
"autogeneratedUsername": true,
"regex": "",
"onboardingStartDate": 1690983052861,
"status": "new",
"flowDetails": {
"name": "..flowname..",
"type": "..type.."
},
"autoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl*********FjNQ",
"loginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortLoginUrl": "https://go-preproduction.signzy.app/realm/login",
"shortAutoLoginUrl": "https://go-preproduction.signzy.app/realm/al/RUl********FjNQ"
}
﻿
Response Field Description
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.
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].
﻿

Key	Required/Optional	Data Type	Description
Header
Content-Type	Required	string	application/json
Authorization	Required	string	authorization token
Body
realmId	Required	string	This is an identifier used by the GO platform, the same will be provided by the Signzy team.
realm	Required	string	Realm returned from the login request
name	Required	string	Name of the partner
email	Required	string	Email ID of the partner
mobile	Required	string	Mobile number of the partner
flowId	Required	string	Flow that is assigned to the partner
signzyAppId	Required	string	This is the reference ID that is used to identify the application

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

Updated 24 Nov 2023

Did this page help you?

Partner Assign Flow

Push Merchant Spec API