Generate IdvWebToken

This API generates a web token used to initiate the IDV (Identity Verification) process via IdvWebServer. The response contains a web_session_id, which is used to redirect the user to the IDV web portal.

Request URL

POST https://<GM-API-SERVER-IP>:9442/v1/idvWebTokens

Request Headers

Header	Value
Authorization	Bearer ACCESS_TOKEN
Content-Type	application/json

Request Body

{
  "userId": "string",                  // Mandatory: REL-ID User ID
  "redirectUri": "string",             // Mandatory: Callback URI post verification
  "payload": "string",                 // Optional: Additional data as JSON string
  "expiresIn": 300,                    // Optional: Expiry in seconds (default from config)
  "errorUri": "string"                 // Optional: Redirect on session expiry or failure
}

Example Request

{
  "userId": "u1",
  "redirectUri": "https://engdev.rel-id.com:8004/IdvWebServer/idvRegistration.htm?token=",
  "payload": "{\"attemptCounter\":\"3\"}",
  "expiresIn": 300,
  "errorUri": "https://engdev.rel-id.com:8004/IdvWebServer/unexpected-error"
}

Success Response

{
  "web_session_id": "cf61b80a-7539-4019-89ce-07f4e3a9cd22"
}

Error Responses

Status	Reason	Example Message
404	User not found	"User does not exist: u1"
422	Invalid or missing fields	"userId is invalid"
500	Internal server error	"Unexpected error at server side"

Redirection URL

Once web_session_id is generated, redirect the user to:

https://<IDV-WEB-SERVER-IP>:8004/IdvWebServer/idvRegistration.htm?token=<web_session_id>

Updated 3 months ago