๐Ÿ”‘# 1 Generate Token API

First Step When Customer Click On Sign Up or Register You Have To Initialize Session And Initialize KYC Request By Creating Session Token Using The Following API

post
Authorizations
Body
tenantIdstringRequired

Organization tenantId

Example: A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6
tenantSecretstringRequired

Organization tenantSecret

Example: A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6
deviceIdstring | nullableOptional

Client's mobile deviceId

Example: A9C3E5D7
correlationIdstring | nullableOptional

correlationId is a unique identifier to trace and query requests by it.

Example: A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6
requestIdstring | nullableOptional

Request Id can be provided to continue the onboarding steps of specific request

Example: 1700398203730
kycRequestTypeIdstring | nullableOptional

KYC Request Type Id can be provided to pick witch Option we will apply such as (OCR - Manual - Upload Excel Sheet)

Example: '1' -> OCR , '2' -> Manual Entry , '3' -> Upload Excel Sheet
userIdstring | nullableOptional

user Id Who Loged into the Application

Example: 1700398203730
userNamestring | nullableOptional

user Name Who Loged into the Application

Example: Ahmed@gmail.com
Responses
200

Success

application/json
post
/Onboarding/api/v1/Auth/GenerateKycOnboardingSessionToken
POST /Onboarding/api/v1/Auth/GenerateKycOnboardingSessionToken HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 349

{
  "tenantId": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
  "tenantSecret": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
  "deviceId": "A9C3E5D7",
  "correlationId": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
  "requestId": "1700398203730",
  "kycRequestTypeId": " '1' -> OCR  ,  '2' -> Manual Entry , '3' -> Upload Excel Sheet",
  "userId": "1700398203730",
  "userName": "Ahmed@gmail.com"
}
{
  "token": "text",
  "expirationDate": "2025-10-27T08:36:09.117Z"
}

Last updated