v1

latestOpenAPI 3.0.02026-07-17647099.1 KB

Links

Get Link

Get a specific link for the provided identity. deepLink and universalLink fields are returned if the credential has an associated protocol message. <br/> To create an offer for the link, use the endpoint /v2/identities/{identifier}/credentials/links/{id}/offer.

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

Path parameters

identifierstring required

Issuer identifier

idstring required

UUID parameter, e.g: 8edd8112-c415-11ed-b036-debe37e1cbd6

Response

Credential link response

idstring required

schemaUrlstring required

schemaTypestring required

schemaHashstring required

credentialSubjectCredentialSubject required

maxIssuanceinteger nullable

issuedClaimsinteger required

expirationstring

credentialExpirationstring

createdAtstring required

activeboolean required

status'active' | 'inactive' | 'exceeded' required

proofTypesstring[] required

deepLinkstring required

universalLinkstring required

Example response

{
  "id": "8edd8112-c415-11ed-b036-debe37e1cbd6",
  "schemaUrl": "https://someValidURL.com",
  "schemaType": "KYCAgeCredential",
  "schemaHash": "c9b2370371b7fa8b3dab2a5ba81b6838",
  "credentialSubject": {
    "birthday": 19960424,
    "documentType": 2,
    "type": "KYCAgeCredential"
  },
  "expiration": "2023-10-26T10:59:08Z",
  "credentialExpiration": "2023-10-26T10:59:08Z",
  "createdAt": "2023-10-26T10:59:08Z",
  "proofTypes": [
    "BJJSignature2021"
  ],
  "deepLink": "iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.privado.id%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4",
  "universalLink": "https://wallet.privado.id#request_uri=url"
}