Get Credential by Credential ID

Get a verifiable credential by the ID associated with it.

This ID will have the format: urn:uuid:<UUID>. For example: urn:uuid:64f9877d-a19a-4205-8d61-f8c2abed5766

API scope required credentials.read. This enpoint will work also with a client side API key.

GET /v1-alpha1/credentials/{id}

Get Credential by Credential ID

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/v1-alpha1/credentials/{id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "$ref": "#/components/examples/Credential"
}

Authorizations

X-API-KEY · string · header · required

Key obtained from the Crossmint developer console, reflecting the API scope granted.

Path Parameters

id · string · required

Unique ID of the credential as returned in the Verifiable Credential NFT creation response. Format is: urn:uuid:<UUID>

Response

200

application/json

Success.

The credential object