API Documentation
Watermark seamlessly in seconds.
Important: Upload one PDF at a time. Each request should include a single file for accurate tracking.
๐ Authentication
Contact [email protected] to request your API key.
Authorization: Bearer YOUR_API_KEY
๐ฅ Endpoint: Watermark PDFs
URL: https://aquamark-decrypt.onrender.com/watermark
Field | Type | Required | Description |
---|---|---|---|
user_email | string | Yes | Your Aquamark account email |
file | file | Yes | One PDF file (max 25MB) |
lender | string | No | Optional lender name to embed in the QR code |
salesperson | string | No | Optional salesperson name to embed in the QR code |
processor | string | No | Optional processor name to embed in the QR code |
state | string | No | Optional State name for compliance and regulation disclaimers |
cURL
curl -X POST "https://aquamark-decrypt.onrender.com/watermark" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "[email protected]" \
-F "[email protected]" \
-F "lender=Fora Financial" \
-F "salesperson=Jack Dawson" \
-F "processor=Rose DeWitt" \
-F "state=CA" \
--output "statement1 - protected.pdf"
๐ซ Postman Setup
- Method: POST
- URL:
https://aquamark-decrypt.onrender.com/watermark
- Authorization:
Bearer YOUR_API_KEY
- Body Type: form-data
- Body Fields:
user_email
(text) โ your Aquamark account emailfile
(file) โ upload your PDF filelender
(text, optional) โ name of lender to embedsalesperson
(text, optional) โ name of salesperson to include in QR codeprocessor
(text, optional) โ name of processor to include in QR codestate
(text, optional) โ state abbreviation or full name (e.g.CA
orCalifornia
)
โ Successful Response
[Returns a protected PDF file]
If a valid state
is provided and matches regulation rules, the response will include a disclaimer in the following header:
X-State-Disclaimer: Disclaimer: CFL license and Disclosure required.
โ Error Responses
Code | Message |
---|---|
401 | Invalid API key |
403 | User not on Enterprise plan |
422 | No logo stored for this user |
429 | Usage limit exceeded |
500 | Internal error |
๐ Notes
- You must be on the Enterprise plan to access the API.
- PDF only. One file per request.
- Upload your watermark logo in the Aquamark portal before using the API.
- Questions? Email [email protected]