Preview credential definition from URI

POST 
/v2/config/digital-wallet/openid/sdjwt/credential-definition/preview

Fetches a credential schema document from a URI so that you can inspect it before you create a credential definition from it. The service downloads the document at credentialDefinitionUri and returns it unchanged in credentialDefinition. For OpenID4VCI 1.0, the document is a claim path pointer document: its claims array holds one entry per claim, each with a path array. Send one request per URI.

Request

Header Parameters

X-SandboxOrgId stringrequired
Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.
The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.
X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.
The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.
Example: 6889e1a4c5b2f30001a3d710

application/json

Body

credentialDefinitionUri urirequired

HTTP or HTTPS URI of the credential schema document to fetch.

Responses

200

Credential schema document fetched successfully

Response Headers

application/json

Schema

Schema

credentialDefinition objectrequired

The schema document that the service fetched from credentialDefinitionUri, returned unchanged.

property name* any

The schema document that the service fetched from credentialDefinitionUri, returned unchanged.

Example (from schema)

{
  "credentialDefinition": {}
}

400

The organisation is unknown, the wallet is not deployed, the URI is missing, or the document could not be fetched or read.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...