Appearance
Document endpoints
The platform serves invoices, receipts, quotes, case documents, and uploaded files. Access checks depend on the document and route.
Use platform user authentication for user-owned documents. Internal case-report routes require administrator API authentication.
GET /invoices/:invoiceId
Return an invoice PDF. The authenticated invoice recipient or an administrator can access it.
bash
curl "https://api.agiodigital.com/invoices/12345?download=true" \
-H "Authorization: Bearer YOUR_USER_ACCESS_TOKEN" \
-o invoice.pdfThe download=true option sets attachment disposition; otherwise the PDF is served inline.
GET /receipts/:receiptId
Return a receipt. The route supports format=html for HTML output and PDF output otherwise. Use download=true for a PDF attachment.
GET /quotes/:quoteId
Return a quote PDF by its numeric ID. The authenticated quote user or an administrator can access it.
bash
curl https://api.agiodigital.com/quotes/12345 \
-H "Authorization: Bearer YOUR_USER_ACCESS_TOKEN" \
-o quote.pdfGET /product-catalog
Return the product catalog for an authenticated platform user. The route supports HTML or PDF output through format.
Internal case documents
| Route | Output |
|---|---|
/pdf/case/:caseId/report | Case report PDF |
/pdf/case/:caseId/agreement | Case agreement PDF |
These routes use the internal administrator API guard. Card partner tokens do not authorize them.
GET /static/file-uploads/:name
Retrieve an uploaded file. The route checks the file's owner, case or fund access, invitation access, or administrator authentication.
The filename must contain the upload's UUID. Authorized requests receive the original file content.
POST /documents/upload
Upload files using administrator authentication and multipart form data. The field name is file; the upload middleware permits up to 50 files and 80 MB per file.
bash
curl https://api.agiodigital.com/documents/upload \
-H "Authorization: Bearer YOUR_ADMIN_USER_ACCESS_TOKEN" \
-F "[email protected]"Other document routes
GET /kyc/documents/:id/fileretrieves a verification document using a signed token.GET /funds/:fundId/user-agreementserves a fund user agreement.GET /wallets/:walletId/sparklineserves wallet performance imagery.
Check the HTTP status and Content-Type before saving a response as a document.