Skip to content
Back to Steward

Exports

An export renders a completed application as a file. All formats read the same underlying record, so a value that appears in the CSV appears in the JSON and the PDF too. They differ in presentation, not in content.

Operation Endpoint Returns
Export CSV GET /applications/{id}/export/csv text/csv
Export JSON GET /applications/{id}/export/json application/json
Export PDF GET /applications/{id}/export/pdf application/pdf
Export XML GET /applications/{id}/export/xml application/xml
Export CRS XML GET /applications/{id}/export/crs-xml application/xml

Every response is the file itself, with a Content-Disposition attachment filename, not a link to fetch later.

export/crs-xml is the earlier standalone CRS endpoint. It still works, but export/xml?template=crs supersedes it and is the one to use in new integrations.

The application record is always included. Four optional sections are off by default and shared across every format: screening, risk, documents, and audit. Each takes true / false, and an unrecognised value is rejected with a 400 rather than being treated as false.

The XML export takes one additional parameter, template, which is either full (the default) or crs.

See the Exports guide for what each section contains, how FATCA/CRS declarations are represented, and the expiry rules on document links.

Terminal window
# A PDF record with risk and screening included
curl -L "https://api.getsteward.ai/api/v1/applications/{id}/export/pdf?risk=true&screening=true" \
-H "Authorization: Bearer stw_live_your_api_key_here" \
-o application.pdf
# A CRS fragment for regulatory filing
curl -L "https://api.getsteward.ai/api/v1/applications/{id}/export/xml?template=crs" \
-H "Authorization: Bearer stw_live_your_api_key_here" \
-o crs.xml