Format Compact Credential as a PDF
This guide will show you how to format your Compact or Compact Semantic Credentials as a PDF document.
Prerequisites
You need the following in order to proceed with this tutorial:
Access to MATTR VII APIs. If you’re experiencing any difficulties, contact us.
The
payload
of a signed Compact or Compact Semantic Credential.A PDF template: This is used by MATTR VII to format the different information from the credential into a PDF document.
Request
Make the following request to format a Compact Credential as a PDF document:
1POST https://YOUR_TENANT_URL/v2/credentials/compact/pdf
You can make a similar request to a different endpoint to format a Compact Semantic Credential as a PDF:
1POST https://YOUR_TENANT_URL/v2/credentials/compact-semantic/pdf
Request body
1{
2 "templateId": "ccad3b98-7086-4556-9e19-9e2aa6ca5c5b",
3 "payload": "CSC:/1/2KCE3IQEJB5DCMSMGZITM5QBE2QFSALWVQAXQI3ENFSDU53FMI5GYZLBOJXC45TJNEXGC5JQGEXG2YLUORZC4Z3MN5RGC3AFDJSZE7YQHIAACAACOFBW65LSONSSAQ3SMVSGK3TUNFQWYBA2NFLDPEDENZQW2ZLPIVWW2YJAJJQW4ZJAKRQXG3LBMRRW6ZDFMZEFGLRSG44HCY3FOJ2GSZTJMNQXI2LPNZHGC3LFOJLW64TLNFXGOIDBOQQEQZLJM5UHI43SMNSXE5DJMZUWGYLUNFXW4TDFOZSWYZ2MMV3GK3BAGRVGS43TOVSXETTBNVSXQGCBMR3GC3TDMVSCAU3BMZSXI6JAKRZGC2LONFXGOZTFPBYGS4TZNIZDAMRWFUYDCLJQGE5AAAIAACRAEAYDPB2WQ5DUOBZTULZPNRSWC4TOFZ3GS2JOMF2TAMJONVQXI5DSFZTWY33CMFWC6Y3POJSS65RSF5RXEZLEMVXHI2LBNRZS6Y3PNVYGCY3UF5ZGK5TPMNQXI2LPNYWWY2LTORZS6OBYG5RWIMJUGAWWKNDEG4WTINJRHAWWENZQMYWTGMBVMIZDGNZXHA4DIOAH3BAFA3FHFPDIRRKK4SM3ZDTKQSRCPRCYIA7RFUZYQI3RIGDHIGLAODJ6K2F245DTLIIKXAD35TORFQ7MVRJCIEPH6SC6NGA4HRMK76H5V6GXP66FFNX7MNYC6MYVU7ZLLXYVLXBU"
4}
templateId
: Use theid
of the PDF template you wish to use to format this credential.payload
: Use theencoded
element from the response obtained when creating the Compact Credential.
Response
The response includes a PDF document displaying information from the credential in accordance with the used PDF template.
Bad request (400) Errors may occur in the following scenarios:
Payload is not a string.
Payload does not match a Compact Credential profile.
The credential has expired.
Unable to validate or decode the payload.
The PDF template does not exist.
The provided template.pdf file doesn't contain a QR code button field.
The decoded payload doesn't include a required claim.
What's next?
Now that you have the Compact or Semantic Credential formatted as a PDF document, you can share it using your selected communication channel (e.g. e-mail, messaging platform, etc.).