OpenID 4VP

PARAMETERShttps://api-testnet.truvera.io/openid/vp/{id}/.well-known/openid-configuration

Path parameters

id*string (uuid)

Proof request UUID

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/.well-known/openid-configuration', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

OID4VP config endpoint

Retrieves the configuration document for a specific proof request UUID. This document is used in OID4VP flows to verify the structure and requirements of the proof request.

GEThttps://api-testnet.truvera.io/openid/vp/{id}/.well-known/openid-configuration

Path parameters

id*string (uuid)

Proof request UUID

Response

200400404

OID4VP config endpoint

Body

application/json

authorization_endpointstring (uri)

The endpoint used by the client to obtain authorization from the resource owner.

Example: "https://example.com/openid/vp/5b40...d96a/authorize"

token_endpointstring (uri)

The endpoint used by the client to exchange an authorization grant for an access token.

Example: "https://example.com/openid/vp/5b40...d96a/token"

jwks_uristring (uri)

The URI for the JSON Web Key Set, which contains the public keys used to verify tokens.

Example: "https://example.com/openid/vp/5b40...d96a/jwks"

issuerstring (uri)

The issuer identifier for the authorization server.

Example: "https://example.com/openid/vp/5b40...d96a"

code_challenge_methods_supportedarray of string

List of supported code challenge methods for PKCE.

token_endpoint_auth_signing_algstring

The algorithm used for signing at the token endpoint.

Example: "HS256"

token_endpoint_auth_signing_alg_values_supportedarray of string

The list of signing algorithms supported by the token endpoint.

request_object_signing_alg_values_supportedarray of string

Supported signing algorithms for request objects.

claims_parameter_supportedboolean

Indicates whether the claims parameter is supported.

Example: true

claims_supportedarray of string

List of claims supported by the issuer.

grant_types_supportedarray of string

List of grant types supported by the authorization server.

id_token_signing_alg_values_supportedarray of string

List of signing algorithms supported for ID tokens.

response_modes_supportedarray of string

List of response modes supported by the authorization server.

response_types_supportedarray of string

List of response types supported by the authorization server.

scopes_supportedarray of string

List of scopes supported by the authorization server.

subject_types_supportedarray of string

List of subject types supported by the issuer.

token_endpoint_auth_methods_supportedarray of string

List of supported token endpoint authentication methods.

request_parameter_supportedboolean

Indicates whether the request parameter is supported.

Example: true

request_uri_parameter_supportedboolean

Indicates whether the request URI parameter is supported.

Example: false

require_request_uri_registrationboolean

Indicates whether request URI registration is required.

Example: true

require_signed_request_objectboolean

Indicates whether a signed request object is required.

Example: true

credential_supportedboolean

Indicates whether credential issuance is supported.

Example: true

dids_supportedboolean

Indicates whether Decentralized Identifiers (DIDs) are supported.

Example: true

did_methods_supportedarray of string

List of DID methods supported by the issuer.

claim_types_supportedarray of string

List of claim types supported by the issuer.

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/.well-known/openid-configuration', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "authorization_endpoint": "https://example.com/openid/vp/5b40...d96a/authorize",
  "token_endpoint": "https://example.com/openid/vp/5b40...d96a/token",
  "jwks_uri": "https://example.com/openid/vp/5b40...d96a/jwks",
  "issuer": "https://example.com/openid/vp/5b40...d96a",
  "code_challenge_methods_supported": [
    "S256"
  ],
  "token_endpoint_auth_signing_alg": "HS256",
  "token_endpoint_auth_signing_alg_values_supported": [
    "HS256"
  ],
  "request_object_signing_alg_values_supported": [
    "EdDSA",
    "ES256"
  ],
  "claims_parameter_supported": true,
  "claims_supported": [
    "sub",
    "sid",
    "auth_time",
    "iss"
  ],
  "grant_types_supported": [
    "authorization_code"
  ],
  "id_token_signing_alg_values_supported": [
    "HS256"
  ],
  "response_modes_supported": [
    "form_post",
    "fragment",
    "query"
  ],
  "response_types_supported": [
    "code id_token",
    "code",
    "id_token",
    "none"
  ],
  "scopes_supported": [
    "openid",
    "openid_credential"
  ],
  "subject_types_supported": [
    "public"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_basic",
    "client_secret_post"
  ],
  "request_parameter_supported": true,
  "request_uri_parameter_supported": false,
  "require_request_uri_registration": true,
  "require_signed_request_object": true,
  "credential_supported": true,
  "dids_supported": true,
  "did_methods_supported": [
    "did:key:",
    "did:web:",
    "did:dock:",
    "did:ebsi:"
  ],
  "claim_types_supported": [
    "normal"
  ]
}

PARAMETERShttps://api-testnet.truvera.io/openid/vp/{id}/jwks

Path parameters

id*string (uuid)

Proof request UUID

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/jwks', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Retrieve JWK set for an OID4VP proof request.

Returns the JSON Web Key Set (JWKS) associated with a specific OID4VP proof request. This is used to verify signatures within the request object.

GEThttps://api-testnet.truvera.io/openid/vp/{id}/jwks

Authorization

rapidAPIaccessTokenbearerAuth

Path parameters

id*string (uuid)

Proof request UUID

Response

200400404

Retrieve JWK set for an OID4VP proof request.

Body

application/json

keysarray of OID4VPJWK (object)

A list of cryptographic keys.

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/jwks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "keys": [
    {
      "kty": "OKP",
      "crv": "Ed25519",
      "x": "Q49t...IT0E",
      "y": "afTq...pD3w",
      "kid": "did:key:z6Mk...MMw48G#z6Mk...MMw48G",
      "alg": "EdDSA"
    }
  ]
}

PARAMETERShttps://api-testnet.truvera.io/openid/vp/{id}/authorize

Path parameters

id*string (uuid)

Proof request UUID

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/authorize', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Redirect to authorize a proof request in OID4VP format.

Redirects the client to the authorization URL for a specific OID4VP proof request. This endpoint is used to initiate the proof request authorization flow.

GEThttps://api-testnet.truvera.io/openid/vp/{id}/authorize

Authorization

rapidAPIaccessTokenbearerAuth

Path parameters

id*string (uuid)

Proof request UUID

Response

302400404

Redirect to the authorization URL.

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/authorize', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "status": 0,
  "type": "text",
  "message": "text"
}

PARAMETERShttps://api-testnet.truvera.io/openid/vp/{id}/request

Path parameters

id*string (uuid)

Proof request UUID

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/request', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Returns the information about the OID4VP request

Returns the proof request object in OID4VP format, which can be used with a request URI for processing verifiable presentations.

GEThttps://api-testnet.truvera.io/openid/vp/{id}/request

Authorization

rapidAPIaccessTokenbearerAuth

Path parameters

id*string (uuid)

Proof request UUID

Response

200400404

Returns the information about the OID4VP request

Body

text/plain

string

Example: "eyJhbG...zKQIDw"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/request', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

eyJhbG...zKQIDw

PARAMETERShttps://api-testnet.truvera.io/openid/vp/{id}/request-url

Path parameters

id*string (uuid)

Proof request UUID

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/request-url', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Get proof request in OID4VP deep link or QR code format

Creates and returns a deep link or QR code for an OID4VP proof request, allowing for easy scanning or clicking by users to initiate the proof process.

POSThttps://api-testnet.truvera.io/openid/vp/{id}/request-url

Path parameters

id*string (uuid)

Proof request UUID

Body

application/json

withIdTokenboolean

withRequestURIboolean

Response

200400401404

Returns the information about the OID4VP request

Body

application/json

urlstring

The generated OpenID request URL

Example: "openid://?client_id=https%3A%2F%2Fexample.com%2Fopenid%2Fvp%2F6600...e165&request_uri=https%3A%2F%2Fexample.com%2Fopenid%2Fvp%2F6600...e165%2Frequest"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/request-url', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404

{
  "url": "openid://?client_id=https%3A%2F%2Fexample.com%2Fopenid%2Fvp%2F6600...e165&request_uri=https%3A%2F%2Fexample.com%2Fopenid%2Fvp%2F6600...e165%2Frequest"
}

PARAMETERShttps://api-testnet.truvera.io/openid/vp/{id}/callback

Path parameters

id*string (uuid)

Proof request UUID

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/callback', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

OID4VP callback submit

Handles the submission of a callback for an OID4VP proof request. This endpoint processes the proof and returns the result to the client.

POSThttps://api-testnet.truvera.io/openid/vp/{id}/callback

Path parameters

id*string (uuid)

Proof request UUID

Body

application/x-www-form-urlencodedtext/plainapplication/json

object

Response

200302400402404

Callback successful (SIOPV2)

Body

application/json

statestring

The state parameter from the request

Example: "RrD3...hapo"

codestring

The code parameter from the request

Example: "jB9b...o030"

verifiedboolean

Whether the request was verified

Example: true

noncestring

The nonce parameter from the request

Example: "1234567890"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/openid/vp/{id}/callback', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
});
const data = await response.json();

Response

200400402404

{
  "state": "RrD3...hapo",
  "code": "jB9b...o030",
  "verified": true,
  "nonce": "1234567890"
}