Seal Formats
Experimental Options For Visualizing Seals
The following examples are experimental and are subject to change.
Seal as HTML Page
Traditionally a Seal is returned via the /getseal
method as a JSON object. If you would like to poll for a Seal and have HTML content returned, here is an example endpoint, header, and body:
POST {{baseUrlHorizon}}/platform/API/v8/getseal HTTP/1.1x-api-key: {{testHorizon}}content-type: application/jsonaccept: application/json{ "retrievalId" : "ri3165452642d684ef62eeb91eadbf37f926412bf6226a7fc3d7699b4a3589c1762","sealWrapper" :"certificateHTML","extract":"documents[0].certificateHTML"}
Seal as PDF
If you would like to poll for a Seal and have PDF content returned use the following:
POST {{baseUrlHorizon}}/platform/API/v8/getseal HTTP/1.1x-api-key: {{testHorizon}}content-type: application/jsonaccept: application/json{ "retrievalId" : "ri3165452642d684ef62eeb91eadbf37f926412bf6226a7fc3d7699b4a3589c1762","sealWrapper" :"certificatePDF","extract":"documents[0].certificatePDF","extractAs":"application/pdf;decodeFrom=base64","extractDisposition":"inline;filename=certificate.pdf"}
Here is an example of such a PDF Seal here
Let's deconstruct that URL: https://developers.cryptowerk.com/platform/API/v8/getseal ?retrievalIds=ri31654973711edf92c37bfbdf4f803d9daf1dd9d2a8eca1ee17433241dd9327636 &sealWrapper=certificatePDF &extract=documents[0].certificatePDF &extractAs=application/pdf;decodeFrom=base64 &extractDisposition=inline;filename=certificate.pdf
When URL encoded becomes: https://developers.cryptowerk.com/platform/API/v8/getseal? retrievalIds=ri31654973711edf92c37bfbdf4f803d9daf1dd9d2a8eca1ee17433241dd9327636 &sealWrapper=certificatePDF &extract=documents%5B0%5D.certificatePDF &extractAs=application%2Fpdf%3BdecodeFrom%3Dbase64 &extractDisposition=inline%3Bfilename%3Dcertificate.pdf
Seal as QR Code
If you would like to poll for a Seal and have a QR Code returned use the following:
POST {{baseUrlHorizon}}/platform/API/v8/getseal HTTP/1.1x-api-key: {{testHorizon}}content-type: application/jsonaccept: application/json{ "retrievalId" : "ri315539637d780a5f2d7f7333b7ad916c7fae79ac20c34c8d37a1ed5a0e9f3f736","sealWrapper" :"QRWithSeal","extract":"documents[0].QRWithSeal.image"}
The response will be a base64 encoded png. To display the QR Code as an image append data:image/png;base64,
to the base64 encoded string. eg
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeAAAAHgAQAAAABVr4M4AAADJ0lEQVR4Xu2UTa7cMAyDc4Pc/5a5QRr+yJl5XRRuFwU....
NOTE
These calls work as POST and as GET. If you are using query strings you may need to URL encode depending on the parameters being sent.
Take note that (when you /register
) the retrievalID must be publiclyRetrievable=true in order for the Seal to be accessible without an API key. Otherwise, like the above examples show you will need to pass your api-key and credentials in the header.
PDF Themes are available. Contact us to inquire about customizing the PDF Seal to include your branding.