v1

latestOpenAPI 3.0.02026-07-17647099.1 KB
Credentials

Get Credentials Offer

Returns a universal/deep link to an offer or raw offer message that can be used for accepting a claim. | Response can be in 3 formats universalLink, deepLink or raw. Default is universalLink. Raw is the raw QR code and link is a QR code with a link to the raw content. Regardless of the type, the field will always be called universalLink.

get/v2/identities/{identifier}/credentials/{id}/offer

Path parameters

identifierstring required

Issuer identifier

idstring required

Claim identifier

Query parameters

type'universalLink' | 'deepLink' | 'raw'

Type:

  • universalLink - (default value) Returns a universal link. The preferred and more standard way to access the offer message
  • deepLink - Returns a deeplink with a link redirection to the original message.
  • raw - Returns the raw offer message.

Response

ok

universalLinkstring required
schemaTypestring required

Example response

{
  "universalLink": "https://wallet.privado.id#request_uri=https%3A%2F%2Fissuer-demo.polygonid.me%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4",
  "schemaType": "vaccinationCertificate"
}