Info API
Last updated
Was this helpful?
Last updated
Was this helpful?
You can find the full YAML swagger specification here
You can find the full JSON swagger specification here
Every API below requires an access token that you can retrieve using the Authorisation API
This API provides access to the final result of the SDK session. However, it is typically not required, as the SDK already returns this result and makes it directly available to your application.
See SDK result for details about the JWS result
This endpoint allows you to delete the session data that has been cached without waiting for the automatic deletion. The session id is the value of the "jti" property of the JWS returned by the uqudo SDK.
This endpoint allows you to download the image based on the resource id provided in the SDK result and returns directly the binary in the response
Returns the information collected during the SDK session. Note: This endpoint it's only necessary when you use the QR code flow, see https://docs.uqudo.com/docs/getting-started/qr-code-app for details.
[\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}Bearer token
GET /api/v1/info/{sessionId} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
textReturns the information collected during the SDK session. Note: This endpoint it's only necessary when you use the QR code flow, see https://docs.uqudo.com/docs/getting-started/qr-code-app for details.
Session ID
[\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}Bearer token
GET /api/v1/info HTTP/1.1
Host: id.uqudo.io
UQ-Session-ID: text
Authorization: text
Accept: */*
textThis endpoint allows you to delete the session data that have been cached without waiting for the automatic deletion. The session id is the value of the "jti" property of the JWS returned by the uqudo SDK.
[\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}Bearer token
DELETE /api/v1/info/{sessionId} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
No content
The following API allows you to download the image based on the resource id provided in the SDK result
Bearer token
GET /api/v1/info/img/{id} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
binary