Integration Guide

Create Merchant API

5min

Introduction
The Create Merchant API creates a new merchant/customer in the system. This API requires an authorisation token or id obtained from the Login API. In the response, the API will generate an auto-login URL for the customer to start their journey.
Sample Request
Create Merchant - Preproduction
Create Merchant cURL - Production
curl --location 'https://go-preproduction.signzy.app/api/applications/66a2413c9c6205eeb0b1bf63/merchants' \
--header 'Authorization:ey*******4NTZ9.OF8Cb-IpUXikYKEgo8Qf-ukJF6P4xxxxxe4' \
--header 'Content-type: application/json' \
--data-raw '{
    "email": "[email protected]",   
    "name": "customer_name",
    “mobile”: "9999999999",
    "realm": "ClientName_VCIP",
    "flowId": "667a6f30e1337f1a85d024ec"
}
'
curl --location 'https://go-preproduction.signzy.app/api/applications/66a2413c9c6205eeb0b1bf63/merchants' \
--header 'Authorization:ey*******4NTZ9.OF8Cb-IpUXikYKEgo8Qf-ukJF6P4xxxxxe4' \
--header 'Content-type: application/json' \
--data-raw '{
    "email": "customer_email@gmail.com",   
    "name": "customer_name",
    “mobile”: "9999999999",
    "realm": "ClientName_VCIP",
    "flowId": "667a6f30e1337f1a85d024ec"
}
'
﻿
To invoke the Create Merchant API, include the Authorization token in the header, which was obtained from the response of the Login API.
Key
Optional/Required
Description
email
Either 'email' or 'mobile' is required
Email Id of the merchant/customer
name
Required
Name of the merchant/customer
mobile
Either 'email' or 'mobile' is required
Mobile number of the merchant/customer
realm
Required
realm details will be provided by the Signzy team
flowId
Required
flowId details will be provided by the Signzy team. This is unique for different flows or jounreys which has been created in the realm.
Sample Response
JS
{
    "id": "6698e64a101f4a4726711dc8",
    "name": "customer_name",
    "email": "[email protected]",
    "mobile": "9999999999",
    "username": "af815527",
    "flowId": "667a6f30e1337f1a85d024ec",
    "realm": "ClientName_VCIP",
    "applicationId": "66796efc2a8e2bc8fd7c50da",
    "isDeleted": false,
    "backopsUserId": "",
    "autogeneratedUsername": true,
    "regex": "",
    "onboardingStartDate": 1721296458053,
    "status": "new",
    "flowDetails": {
        "name": "VKYC Journey",
        "type": "mainflow"
    },
    "autoLoginUrl": "https://go.onboardings.co/ClientName_VCIP/al/UmF6b3JwYXlfVkNJUDphZjgxNTUyNyYmM2QwMjVkOTI",
    "loginUrl": "https://go.onboardings.co/ClientName_VCIP/login",
    "shortLoginUrl": "https://go.onboardings.co/ClientName_VCIP/login",
    "shortAutoLoginUrl": "https://go.onboardings.co/ClientName_VCIP/al/UmF6b3JwYXlfVkNJUDphZjgxNTUyNyYmM2QwMjVkOTI",
    "signzyAppId": 1000035
}

{
    "id": "6698e64a101f4a4726711dc8",
    "name": "customer_name",
    "email": "customer_email@gmail.com",
    "mobile": "9999999999",
    "username": "af815527",
    "flowId": "667a6f30e1337f1a85d024ec",
    "realm": "ClientName_VCIP",
    "applicationId": "66796efc2a8e2bc8fd7c50da",
    "isDeleted": false,
    "backopsUserId": "",
    "autogeneratedUsername": true,
    "regex": "",
    "onboardingStartDate": 1721296458053,
    "status": "new",
    "flowDetails": {
        "name": "VKYC Journey",
        "type": "mainflow"
    },
    "autoLoginUrl": "https://go.onboardings.co/ClientName_VCIP/al/UmF6b3JwYXlfVkNJUDphZjgxNTUyNyYmM2QwMjVkOTI",
    "loginUrl": "https://go.onboardings.co/ClientName_VCIP/login",
    "shortLoginUrl": "https://go.onboardings.co/ClientName_VCIP/login",
    "shortAutoLoginUrl": "https://go.onboardings.co/ClientName_VCIP/al/UmF6b3JwYXlfVkNJUDphZjgxNTUyNyYmM2QwMjVkOTI",
    "signzyAppId": 1000035
}
﻿
Key
Description
id
This is the unique ID of the merchant/customer for this particular autoLoginUrl
name
Name of the merchant/customer
email
Email of the merchant/customer
mobile
Mobile number of the merchant/customer
flowId
The flow for which the journey link has been created.
realm
Realm name on which the autoLoginUrl is associated with
autoLoginUrl
This is the URL where the merchant/customer needs to be redirected to commence the onboarding journey.
shortAutoLoginUrl
Shortened AutoLogin URL
id is the unique identifier of the customer for that particular journey. Even if customer does multiple retries for same autoLoginURL, the id remains constant.
autoLoginURL is the URL, where merchant/custoemer should be redirected to complete the onboarding journey.
﻿Note: ﻿
The Create Merchant API can be modified as per clients requirement, the extra data whatever clients want to pass can be shared by the create merchant API and same will be shared to maker and checker for Video KYC process. 
 For example, if client only wants Video KYC service and needs to send the EKYC details or Aadhar details and PAN details or any other data, in that case the Create Merchant API will be configured by the signzy team as per client requirement.
﻿

Key	Optional/Required	Description
email	Either 'email' or 'mobile' is required	Email Id of the merchant/customer
name	Required	Name of the merchant/customer
mobile	Either 'email' or 'mobile' is required	Mobile number of the merchant/customer
realm	Required	realm details will be provided by the Signzy team
flowId	Required	flowId details will be provided by the Signzy team. This is unique for different flows or jounreys which has been created in the realm.

Key	Description
id	This is the unique ID of the merchant/customer for this particular autoLoginUrl
name	Name of the merchant/customer
email	Email of the merchant/customer
mobile	Mobile number of the merchant/customer
flowId	The flow for which the journey link has been created.
realm	Realm name on which the autoLoginUrl is associated with
autoLoginUrl	This is the URL where the merchant/customer needs to be redirected to commence the onboarding journey.
shortAutoLoginUrl	Shortened AutoLogin URL

Updated 13 Sep 2024

Did this page help you?

Data Level Callbacks

Create Merchant API

Introduction

Sample Request

Sample Response

﻿Note: ﻿

Note: