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

The following API allows you to get the final result of the SDK session.

Note: This endpoint it’s only necessary when you use the QR code flow, see QR Code APP for details. The SDK returns the same result and makes it available directly to your application.

Info API

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.

GEThttps://id.uqudo.io/api/v1/info/{sessionId}

Path parameters

sessionId*string

Header parameters

Response

200400401403500

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

Body

application/jwt

string

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/info/{sessionId}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200

text

Info API

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.

GEThttps://id.uqudo.io/api/v1/info

Header parameters

Response

200400401403500

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

Body

application/jwt

string

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/info', {
    method: 'GET',
    headers: {
      "UQ-Session-ID": "text",
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200

text

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

Info delete API

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.

DELETEhttps://id.uqudo.io/api/v1/info/{sessionId}

Path parameters

sessionId*string

Header parameters

Response

204401403500

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/info/{sessionId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

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

Info image API

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

GEThttps://id.uqudo.io/api/v1/info/img/{id}

Path parameters

id*string

Header parameters

Response

200400401403404500

Image file

Body

image/jpeg

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/info/img/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200

binary