heyvisa

PDF Export

Every completed report can be exported as a polished, branded PDF — ideal for sharing with applicants over email or attaching to an internal case file.

Direct download

Hit the export endpoint with format=pdf and you will get the binary back with appropriate Content-Disposition headers so the file downloads with a sensible name.

bash
curl -L https://api.heyvisa.com/v1/reports/rep_01HXYZ.../export?format=pdf \
  -H "Authorization: Bearer $HEYVISA_API_KEY" \
  --output report.pdf
http
200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="heyvisa-report-rep_01HXYZ.pdf"
Content-Length: 184213
X-Report-Id: rep_01HXYZ...
X-Report-Locale: en-US

%PDF-1.7
...

Query parameters

ParameterTypeDefaultDescription
formatenumpdfCurrently pdf · json · html.
localestringen-USRender language. Currently en-US, tr-TR, de-DE, fr-FR.
includestringallComma list: summary · documents · recommendations · raw.
brandstringworkspaceOverride workspace branding with white-label · partner_id.

Signed URLs

For browser downloads or email links, prefer signed URLs over forwarding the API key. POST to the export endpoint to mint a short-lived URL hosted on files.heyvisa.com.

bash
curl -X POST https://api.heyvisa.com/v1/reports/rep_01HXYZ.../export \
  -H "Authorization: Bearer $HEYVISA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "format": "pdf", "expires_in": 600 }'

# Response
{
  "url": "https://files.heyvisa.com/exports/abc123.pdf?sig=...",
  "expires_at": "2026-06-11T09:35:14Z"
}
Caching
PDFs are deterministic for the report's current state. We cache generated PDFs for 24 hours; replacing a document or recomputing the report invalidates the cache automatically.