--- title: Callback API (Partner) slug: generic-onboarding/callback-api-partner description: Learn how to enable event-based callbacks for partners using our API. This document covers the required and optional fields, including a sample request. It also includes important information about a merchant's signup and data, such as their ID, contact i createdAt: 2023-08-03T07:54:09.473Z --- ## 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 ::::Tabs :::Tab{title="Preproduction"} ```curl curl --location 'https://{base_URL}/api/distributors/callback' \ --header 'Authorization: ey*********NLEEzM6jBCL8' \ --header 'Content-Type: application/json' \ --data '{ "distributorId":"62******31", "realmId":"62******94", "flowId": "62******56", "callbacks":{ "accept":"https://webhook.site/6a******41" } }’ ``` ::: :::: ## 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 { "merchantSignup": {}, "merchantData": { "id": "64******95", "name": "..name..", "email": "..email..", "mobile": "..mobile..", "username": "..username..", "flowId": "62******56", "realm": "..realm..", "applicationId": "62******94", "distributorId": "62******31", "isDeleted": false, "backopsUserId": "", "realmId": "62******94", "signzyAppId": "dh*****25", "autogeneratedUsername": true, "regex": "", "onboardingStartDate": 1690801598765, "status": "accept", "flowDetails": { "name": "..flowname..", "type": "..flowtype.." }, "autoLoginUrl": "https://{base_URL}/EIR/al/RUl****Zg", "loginUrl": "https://{base_URL}/EIR/login", "shortLoginUrl": "https://{base_URL}/EIR/login", "shortAutoLoginUrl": "https://{base_URL}/EIR/al/RUl****Zg", "eventSource": "webapp", "eventStatus": "onboardingCompleted", "initialSubmissionDate": 1690801883951, "onboardingEndDate": 1690801883951, "subStatus": "notEscalated", "decisionEngineResult": "uncertain", "actionBy": "EIR_backops1", "actionTime": 1690983815934, "backopsUser": { "id": "62******fa", "name": "..name..", "username": "..username..", "email": "..email..", "password": "..password..", "mobile": "..mobile..", "realm": "..realm..", "isDormant": false, "applicationId": "62*****94", "managerToggle": null, "manager": null, "managerName": null, "profileSettings": { "timeZoneValue": "Asia/Kolkata", "dateFormat": "DD/MM/YYYY", "timeFormat": "HH:mm:ss" }, "jobTimestamp": null, "employeeCode": null, "designationId": null, "assignment": { "count": 0, "actionTaken": 0 }, "invalidLoginAttempt": 0, "invalidLoginAttemptSession": null, "lastLoginAt": 1690983469213, "passwordLastModifiedOn": 1658835716597, "lastLogoutAt": 1689607873794 }, "designation": "", "draftsCount": 0, "instructions": "", "reason": "", "internalNotes": [ { "id": "64*****6e", "message": { "instructions": "", "subject": "accept", "reason": "" }, "logTime": "2023-08-02T13:43:35.942Z", "type": "logs", "merchantId": "64*****95", "action": "accept", "escalateLog": "Application escalated", "actionBy": "EIR_backops1", "backopsUserId": "62******fa", "_id": "64******6e" } ], "data": [ { "id": "64******44", "pageId": "62******4f", "flowId": "62*******56", "data": { "AadhaarImage1": "File URL", "AadhaarName": "Name", "AadhaarUid": "Uid", "AadhaarVid": "Vid", "AadhaarDob": "Date Of Birth", "AadhaarYob": "Year Of Birth", "AadhaarPincode": "Pincode", "AadhaarAddress": "Address", "AadhaarGender": "Gender", "AadhaarUidHash": "UID Hash", "Aadhaarstate": "State", "Aadhaardistrict": "District", "Aadhaarcity": "City", "Aadhaarcountry": "Country", "type": "Digilocker Aadhaar", "widgetName": "Digilocker Aadhaar" }, "merchantId": "64*****95", "applicationId": "62******94", "pageName": "Aadhaar Upload", "uid": "64******95", "type": "..type..", "widgetName": "..widget name..", "pageType": "..page type..", "isSubFlow": false, "_id": "64******44" }, { "id": "64*******46", "pageId": "62*******50", "flowId": "62******56", "data": { "PANtoGSTApplicationStatus": "Application Status", "PANtoGSTRegistrationName": "Registration Name", "PANtoGSTMobNum": "Mobile Number", "PANtoGSTRegType": "Registration Type", "PANtoGSTEmailId": "Email Id", "PANtoGSTTinNumber": "Tin Number", "PANtoGSTGstinRefId": "Gstin RefId", "PANtoGSTGstin": "Gstin", "PANtoGSTConstitutionOfBusiness": "Constitution Of Business", "PANtoGSTLegalNameOfBusiness": "Legal Name Of Business", "PANtoGSTTradeNameOfBusiness": "Trade Name Of Business", "PANtoGSTCentreJurisdiction": "Centre Jurisdiction", "PANtoGSTStateJurisdiction": "State Jurisdiction", "PANtoGSTRegistrationDate": "Registration Date", "PANtoGSTTaxPayerDate": "Tax Payer Date", "PANtoGSTTaxPayerType": "Tax Payer Type", "PANtoGSTGstinStatus": "Gstin Status", "PANtoGSTCancellationDate": "Cancellation Date", "PANtoGSTNatureOfBusinessActivities": "Nature Of Business Activities", "PANtoGSTPrincipalPlaceAddress": "Principal Place Address", "PANtoGSTPrincipalPlaceLatitude": "Principal Place Latitude", "PANtoGSTPrincipalPlaceLongitude": "Principal Place Longitude", "PANtoGSTPrincipalPlaceBuildingNameFromGST": "Principal Place Building Name From GST", "PANtoGSTPrincipalPlaceBuildingNoFromGST": "Principal Place Building No From GST", "PANtoGSTPrincipalPlaceFlatNo": "Principal Place Flat No", "PANtoGSTPrincipalPlaceStreet": "Principal Place Street", "PANtoGSTPrincipalPlaceLocality": "Principal Place Locality", "PANtoGSTPrincipalPlaceCity": "Principal Place City", "PANtoGSTPrincipalPlaceDistrict": "Principal Place District", "PANtoGSTPrincipalPlaceState": "Principal Place State", "PANtoGSTPrincipalPlacePincode": "Principal Place Pincode", "PANtoGSTAdditionalPlaceAddress": "Additional Place Address", "PANtoGSTAdditionalPlaceLatitude": "Additional Place Latitude", "PANtoGSTAdditionalPlaceLongitude": "Additional Place Longitude", "PANtoGSTAdditionalPlaceBuildingNameFromGST": "Additional Place Building Name From GST", "PANtoGSTAdditionalPlaceBuildingNoFromGST": "Additional Place Building No From GST", "PANtoGSTAdditionalPlaceFlatNo": "Additional Place Flat No", "PANtoGSTAdditionalPlaceStreet": "Additional Place Street", "PANtoGSTAdditionalPlaceLocality": "Additional Place Locality", "PANtoGSTAdditionalPlaceCity": "Additional Place City", "PANtoGSTAdditionalPlaceDistrict": "Additional Place District", "PANtoGSTAdditionalPlaceState": "Additional Place State", "PANtoGSTAdditionalPlacePincode": "Additional Place Pincode", "type": "PAN to GST", "widgetName": "PAN to GST" }, "merchantId": "64*******95", "applicationId": "62*******94", "pageName": "pan TO gst", "uid": "64******95", "type": "PAN to GST", "widgetName": "PAN to GST", "pageType": "Data&Document", "isSubFlow": false, "_id": "64*******46" }, { "id": "64******47", "pageId": "62******fa", "flowId": "62******56", "data": { "address": "Aadhaaraddress", "adhaaradress": "Aadhaar address", "gstaddress": "GST address", "enteraddress": "Enter Address", "type": "Manual Data Entry", "widgetName": "Manual Data Entry" }, "merchantId": "64*******95", "applicationId": "62*******94", "pageName": "Address Details", "uid": "64******95", "type": "Manual Data Entry", "widgetName": "Manual Data Entry", "pageType": "Manual Data Entry", "isSubFlow": false, "_id": "64********47" }, { "id": "64*******48", "pageId": "62*******9e", "flowId": "62********56", "data": { "audioMatchScore": "Audio Match Score", "videoMatchScore": "Video Match Score", "videoCoVariance": "video CoVariance", "videoFinalImage": {url}, "videoUrl": {url}, "videoOtp": {url}, "videoFaceLandmark": "Video Face Landmark Image URL", "videoPrerecordedRisk": "Video Pre-recorded Risk", "videoStaticRisk": "video Static Risk", "videoLandMark": "Video Landmark", "type": "Video Verification", "widgetName": "Video Verification" }, "merchantId": "64*****95", "applicationId": "62******94", "pageName": "Video Verification", "uid": "64******95", "type": "Video Verification", "widgetName": "Video Verification", "pageType": "Video Verification", "isSubFlow": false, "_id": "64*****48" }, { "id": "64******49", "pageId": "62******41", "flowId": "62******56", "data": { "BusinessPanImage": "File URL", "BusinessPanName": "Name", "BusinessPanDateOfIssue": "Date Of Issue", "BusinessPanPanNumber": "Pan Number", "type": "Business PAN", "widgetName": "Business PAN" }, "merchantId": "64******95", "applicationId": "62*****94", "pageName": "Business PAN", "uid": "64*****95", "type": "Business PAN", "widgetName": "Business PAN", "pageType": "Data&Document", "isSubFlow": false, "_id": "64*****49" } ], "backopsUserDetails": [], "_id": "64*****95" }, "matcherData": [], "merchantAuditData": [], "submerchantAuditData": [] } ``` | **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 | :::hint{type="info"} ### 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 [help@signzy.com](#). :::