v1

latestOpenAPI 3.0.02026-07-17647099.1 KB

Links

Get Links

Returns a list of links for the provided identity. Filter between all | active | inactive | exceeded links and also perform a full text search with the query parameter.

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

Path parameters

identifierstring required

Issuer identifier

Query parameters

querystring

Query string to do full text search in schema types and attributes.

status'all' | 'active' | 'inactive' | 'exceeded'

Schema type:

all - All links. (default value)
active - Only active links. (Not expired, no issuance exceeded and not deactivated
inactive - Only deactivated links
exceeded - Expired or maximum issuance exceeded

Response

Link collection

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"
  }
]