search
HomeCustomer PortalBook a Demo

Info API

You can find the full YAML swagger specification herearrow-up-right

You can find the full JSON swagger specification herearrow-up-right

Every API below requires an access token that you can retrieve using the Authorisation API

hashtag
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.

hashtag
Info API

get

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.

Path parameters
sessionIdstringRequiredPattern: [\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}
Header parameters
AuthorizationstringRequired

Bearer token

Responses
chevron-right
200

String representing a JWS Compact Serialization, a representation of the JWS as a compact, URL-safe string

application/jwt
Responsestring
get
/api/v1/info/{sessionId}

hashtag
Info API

get

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.

Header parameters
UQ-Session-IDstringRequired

Session ID

Pattern: [\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}
AuthorizationstringRequired

Bearer token

Responses
chevron-right
200

String representing a JWS Compact Serialization, a representation of the JWS as a compact, URL-safe string

application/jwt
Responsestring
get
/api/v1/info

See SDK result for details about the JWS result

hashtag
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.

hashtag
Info delete API

delete

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.

Path parameters
sessionIdstringRequiredPattern: [\p{XDigit}]{8}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{4}-[\p{XDigit}]{12}
Header parameters
AuthorizationstringRequired

Bearer token

Responses
delete
/api/v1/info/{sessionId}
No content

hashtag
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

hashtag
Info image API

get

The following API allows you to download the image based on the resource id provided in the SDK result

Path parameters
idstringRequired
Header parameters
AuthorizationstringRequired

Bearer token

Responses
chevron-right
200

Image file

image/jpeg
Responsestring · binary
get
/api/v1/info/img/{id}

PreviousMRZ only (TD1 or TD3)NextFace API

Last updated

Was this helpful?