Generate User Token

Generates a user token that must be passed to the IAB native SDK. Note: This API is only needed for Native SDK integration, not for H5/Web integration.

get/v2/coe/authentication

Request

  • Base URL
    https://onekyc-token-sandbox.gopayapi.com
  • URL
    https://onekyc-token-sandbox.gopayapi.com/v2/coe/authentication
  • Auth
    none declared. Required headers: client-id, pass-key, x-onboarding-partner, x-partner-user-id, x-partner-user-id-type

Headers

client-idstring required

Static key representing the Client ID of the partner. Generated by the IAB team.

pass-keystring required

Static key representing the Pass Key of the Client ID. Generated by the IAB team.

x-onboarding-partnerstring required

Used to identify the source of the request. Example: CLIENT_X-SDK-COE_FACE_VERIFICATION.

x-partner-user-idstring required

User ID of the current session. IAB ties this info to the resulting submission ID.

x-partner-user-id-typestring required

Detailed type name of the User ID. Identifies the type of user ID sent to IAB.

Response

Successful user token generation

successboolean

Status of the API call

Changes

No recorded changes to this operation across all 1 revision of this API.