Info API
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
Info 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.
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
String representing a JWS Compact Serialization, a representation of the JWS as a compact, URL-safe string
Bad Request: Missing required input or invalid format
Unauthorized: No valid access token has been provided
Forbidden: Access token doesn't have permission to use the requested feature
Internal Server Error: Unexpected error
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
String representing a JWS Compact Serialization, a representation of the JWS as a compact, URL-safe string
Bad Request: Missing required input or invalid format
Unauthorized: No valid access token has been provided
Forbidden: Access token doesn't have permission to use the requested feature
Internal Server Error: Unexpected error
GET /api/v1/info HTTP/1.1
Host: id.uqudo.io
UQ-Session-ID: text
Authorization: text
Accept: */*
textSee SDK result for details about the JWS result
Info delete API
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 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
No Content
Unauthorized: No valid access token has been provided
Forbidden: Access token doesn't have permission to use the requested feature
Internal Server Error: Unexpected error
DELETE /api/v1/info/{sessionId} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
No content
Info image API
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
The following API allows you to download the image based on the resource id provided in the SDK result
Bearer token
Image file
Bad Request: Missing required input or invalid format
Unauthorized: No valid access token has been provided
Forbidden: Access token doesn't have permission to use the requested feature
Not Found: Resource not found or expired. Images are kept only for the duration of the session, 30 minutes.
Internal Server Error: Unexpected error
GET /api/v1/info/img/{id} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
binaryLast updated
Was this helpful?