Scan the QR code

The QR code reader is used to read the QR code rendered on the web page. The text retrieved from the QR code reader is used to call the uqudo backend to retrieve the information related to the session, as described below:

$ curl -v \
-H 'Authorization: <qrCodeText>' \
https://idws.uqudo.io/api/v1/session

Response:
{
  "sessionId": "",
  "token": "",
  "data": ""
}

Or:

$ curl -v \
https://idws.uqudo.io/api/v1/session/{qrCodeText}

Response:
{
  "sessionId": "",
  "token": "",
  "data": ""
}

Request:

Property	Type	Optional	Description
<qrCodeText>	string	No	Authorization header or path variable

Response:

Property	Type	Optional	Description
sessionId	string	No	Session ID used to initialize the Uqudo Builder, see Uqudo Builder Configuration
token	string	No	Authorization token used to initialize the Uqudo Builder, see Uqudo Builder Configuration
data	string	No	Data that the application needs to parse in order to know the type of onboarding process to trigger with the uqudo SDK. It could be a JSON object for instance.

After retrieving the session information, you can start the enrolment process using the uqudo SDK. Please refer to Enrolment Flow for details.

The session information related to the qrCodeText gets automatically deleted after 30 minutes after its creation (Create a Session) but you can delete it using the request below (e.g. after the KYC session is completed):

$ curl -v \
-X DELETE \
https://idws.uqudo.io/api/v1/session/{qrCodeText}

Response status 204 No Content