PDF Handling

The PDF generated through the API is watermarked to secure the authenticity of the originating document. The watermark is applied to both pDoc and eDoc. Please review Copy BOLthe endpoint for technical implementation details.

Original Document

The Original watermark appears for the documents that are assigned to or under the HOLD of the existing queried customer.

e.g. The below cURL is having a setId: 52792116-dd88-4a85-bd53-74b60900385a which have a documenteId: 53c7b28a-5a1e-4553-8c17-0e02fe70599f. This shipment and the eBoL is holded by the customerId: 0a2ac7f2-44e4-11e9-9ed6-0a24491b68de.

cURL

curl --location --request GET 'https://api-test.cargodocs.com/v3/common/sets/52792116-dd88-4a85-bd53-74b60900385a/get-single-pdf/53c7b28a-5a1e-4553-8c17-0e02fe70599f?customerId=0a2ac7f2-44e4-11e9-9ed6-0a24491b68de' \
--header 'Authorization: Bearer 1UqsIw1ZGOQsu2rSaRAUCXYjLXHlHV5i3lUEoX2RGPfmrtX-hInE0elEFLMthly2GwjCjxBSWoNIeSjJ23GA' \
--header 'Cookie: JSESSIONID=E3105F83CDB3EB736F41B7FD0F48772C' \
--data-raw ''

Copy Document

A document with a COPY watermark will appear in 2 cases.

• If the shipment or relevant document falls under a different customer.
• If the endpoint is consumed with copy=true property.

Here is an example of a Copy BOL endpoint having an additional parameter copy=true.

cURL

curl --location --request GET 'https://api-test.cargodocs.com/v3/common/sets/2ddee4bc-9830-4647-9693-42581d5f1828/get-single-pdf/c1fb77e8-b36c-4431-a484-f5576504f3dd?customerId=0a2b924a-44e4-11e9-9ed6-0a24491b68de&copy=true' \
--header 'Authorization: Bearer eyJraWQiOiJPUUJmaXR6KzBWOFlxWFp3N2lHc1hlWjB5T2I3RTNyekpGWGZUYm9cL0M0Yz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJiMTc3OTIzMi1iNmY2LTQwNDYtYmI0NC05MjIyZDVmNGY5MjEiLCJldmVudF9pZCI6ImUwODZlYmQ2LWY0ZDItNGExNC04OWNhLTA3YzUxY2E1YjZhZiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE2NTY1ODYyNzAsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5ldS13ZXN0LTEuYW1hem9uYXdzLmNvbVwvZXUtd2VzdC0xX1drRmF1Q2tnUSIsImV4cCI6MTY1NjU4OTg2OSwiaWF0IjoxNjU2NTg2MjcwLCJqdGkiOiI0OWUyMzVkNS03MTBmLTRhN2QtOGJmNi1mNzQ4Zjk1OWQwOGQiLCJjbGllbnRfaWQiOiI3bzh0dDI4OWNvNHU5NnQ5bHQ1MnFyMnZxYSIsInVzZXJuYW1lIjoiQkhQQ09OTkVDVCJ9.aQEr7ZCGUikBW8xyxfs4ygLsqokAYwXt424H2wW5omwcokySUYsdpmSu5ocTsXaq6Of9reJzVkP63Ag82akKpUjjpLFjRRPo4MLA6sMm1aDalDd9JIfoXd1h3a6nJfzCp4U8s2zz_im_STKbPhGHoDgTwP1GumxdvOrJ2JmjdawG3N54bZ5NeZnsj0qRJyaRitl3WFzLNWpPUbQgt6n2Lws-c0NlQ99QYjAUrXckTKgH32ar3HTMTC37mDEOEtXd2MPK0s_N51CzUCxyoRIWsjDHdl2Ayr-UmQW6Tz6aH2aHdbAuzxG32Bo9EqlHPd6mCSr0AVupAeHiruXmAX__tQ' \
--data-raw ''

Despite the eBoL being assigned under the specific customer, the API will retrieve the document with COPY watermark over it.

⚠

️ COPY Watermark

The API will return the PDF with a COPY watermark if the original document is under the hold of another customer. Despite with or without copy=true property.