Hubix Developer PortalGetting started
Document Processing reads business documents in the formats Hubix knows, and converts, validates, inspects or unwraps them. Every operation takes the document itself as the request body.
Before you start
- An access token. Every call carries a bearer token issued to your organization's API client:
Authorization: Bearer <token>. - An API version. Send
?api-version=1.0or thex-api-version: 1.0header. Without one, a call is answered as version 1.0.
What you can do
| To | Call |
|---|---|
| Find out what a document is, and who it is between | POST /inspect-document |
| See which formats a kind of document converts to | GET /output-formats |
| Convert a document to another Hubix format | POST /convert-document |
| Validate a document as it is | POST /validate-document |
| Lift one envelope layer, such as an SBDH | POST /unwrap-document |
Converting never validates: validate the result with a separate call when you need to.
A typical flow
- Inspect the document to learn its format and kind.
- Ask for the output formats of that kind, and pick the one you need.
- Convert to it, then validate the result before you send it on.
A document that is too large is answered with 413, and one that is empty or cannot be read with 422.
Errors describes the problem details every operation can answer.