Issuance
Sign a Semantic CWT credential
Returns a signed Semantic CWT credential generated from a provided valid payload.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>Semantic CWT credential payload to sign
application/json- body
Sign Semantic CWT credential Request
payload*CompactSemanticCredentialSignRequest
revocable?booleanWhen set to true, the created credential can later be revoked. When set to false, the credential cannot be revoked.
falseisRevoked?booleanWhen set to true, the signed credential is issued as revoked, and must be unrevoked to become valid. If isRevoked is provided (e.g. set to either true or false), revocable must be set to true.
falseSemantic CWT credential signed
application/json- response
Sign Semantic CWT credential response
id*stringUnique credential identifier. This is identical to the jti claim, which is the CBOR Web Token (CWT) identifier.
encoded*stringThe base32 encoded string representation of the Semantic CWT credential. CSC stands for COSE_SIGN Compact format. You will use this element to convert the credential into a format that can be shared with a holder.
decoded*CompactSemanticCredentialSignResponse
curl -X POST "https://example.com/v2/credentials/compact-semantic/sign" \ -H "Content-Type: application/json" \ -d '{ "payload": { "iss": "did:web:organization.com", "vc": { "type": "AlumniCredential", "credentialSubject": { "property1": "...", "property2": "..." } } } }'{ "id": "string", "encoded": "CSS:/1/BASE_32_ENCODED_PAYLOAD", "decoded": { "iss": "did:web:example.com", "jti": "...", "nbf": 1645743759, "exp": 1645743759, "iat": 1645743759, "aud": "...", "sub": "...", "vc": { "@context": [ "https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1" ], "type": [ "VerifiableCredential", "AlumniCredential" ], "credentialSubject": { "property1": "...", "property2": "..." } }, "status": { "url": "...", "index": 123 } }}Format a Semantic CWT credential as a QR code
Returns a QR code representation of a Semantic CWT credential from a provided encoded string representation of that credential.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>application/json- body
payload*stringString representation of the encoded CWT credential.
width?numberOptionally specify the desired width of the output QR code. When no width is specified MATTR VII will generate a QR code with an optimised width based on the size of the payload. Maximal value is 1000px.
QR code generated
response?fileimage/pngbinarycurl -X POST "https://example.com/v2/credentials/compact-semantic/qrcode" \ -H "Content-Type: application/json" \ -d '{ "payload": "CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L..." }'"string"Format a Semantic CWT credential as a PDF
Returns a PDF representation of a provided CWT credential based on an existing PDF template.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>The credential payload
application/json- body
templateId?stringUse the ID element of the PDF template to be used to format this credential.
1 <= lengthpayload?stringString payload representation of the encoded CWT credential.
1 <= length <= 1024PDF created
response?unknownapplication/pdfbinarycurl -X POST "https://example.com/v2/credentials/compact-semantic/pdf" \ -H "Content-Type: application/json" \ -d '{ "templateId": "4eea7654-d4c5-4eba-bd7a-5ca334d54725", "payload": "{payload}" }'nullFormat a Semantic CWT credential as an Apple Pass
Returns an Apple Pass representation of a provided Semantic CWT credential based on an existing Apple Pass template.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>body*CreateDigitalPassRequestapplication/jsonobjectApple Pass created
response?CreateApplePassResponseapplication/vnd.apple.pkpassThe generated Apple Pass .pkpass file.
binarycurl -X POST "https://example.com/v2/credentials/compact-semantic/digital-pass/apple" \ -H "Content-Type: application/json" \ -d '{ "templateId": "3812166c-ac9f-4e4e-96dd-c1336b5be378", "payload": "{payload}" }'"string"Format a Semantic CWT credential as a Google Pass
Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>body*CreateDigitalPassRequestapplication/jsonobjectGoogle Pass created
response?CreateGooglePassResponseapplication/jsonThe URL to retrieve the Google Pass from.
objectcurl -X POST "https://example.com/v2/credentials/compact-semantic/digital-pass/google" \ -H "Content-Type: application/json" \ -d '{ "templateId": "3812166c-ac9f-4e4e-96dd-c1336b5be378", "payload": "{payload}" }'{ "redirectTo": "https://pay.google.com/gp/v/save/{jwt}"}How would you rate this page?
Last updated on