🆙#3 Initialize Request

This API is to creating and initialize new request to start onboarding steps.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

deviceModelstring · nullableOptional

Client's mobile device model

Example: iPhone 8 Plus

manufacturerNamestring · nullableOptional

Client's mobile manufacturer name

Example: Apple

imeistring · nullableOptional

Client's mobile imei

Example: EFF71C0C-2F53-4E1C-85C6-B067889F4805

defaultPayLoadobject · nullableOptional

Organization can add custom json object related to client and received it at call back object

Example: {"key1":"value1", "key2":"value2"}

Responses

200

Success

application/json

requestIdstringRequired

The identifier of created request

Example: 1700473556670

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/Request/InitializeRequest

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/Request/InitializeRequest HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "deviceModel": "iPhone 8 Plus",
  "manufacturerName": "Apple",
  "imei": "EFF71C0C-2F53-4E1C-85C6-B067889F4805",
  "defaultPayLoad": "{\"key1\":\"value1\", \"key2\":\"value2\"}"
}

{
  "requestId": "1700473556670"
}