Overview
Integration API reference (v1)
Section titled “Integration API reference (v1)”This reference describes every call of the Integration API — one page per operation, with a ready-to-copy command and an example of the response.
If this is your first contact with the API, do not start here. Quick Start takes you from nothing to a submitted document in five steps; this page is what you open afterwards, once you know what you are looking for.
The calls are grouped into four areas, in the menu on the left:
| Area | What it covers |
|---|---|
| Ping | one check — whether the connection and the key are valid |
| Outbound | everything about a document you submit: submission, status, history, download, cancellation |
| Inbound | documents that arrive for you, and the acknowledgement that you took them over |
| Codelists | the code lists used by the fields inside the document |
Every call carries two headers — X-Api-Key and X-Software-Id. How to request a key is on
Authentication; the limits and rules are on
Limits and rules; every code you see in a response has its own row in the
Error catalogue.
- OpenAPI version: 3.0.1