Process Document (Beta)

post

https://api.joinpopp.com/v1/documents/process

Beta — endpoint shape and validation rules may evolve before general availability.

Classify and validate an uploaded document against a caller-supplied document type definition. Stateless: every call carries the full document type config inline; no organisation-level catalogue lookup is performed. A stateful variant that resolves by documentTypeId is planned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Process Document Request

Request to classify and validate a document. Beta endpoint, stateless: every call carries the document type definition inline. Supply the document via documentBase64 (inline) or documentUrl (server downloads); exactly one of the two is required. Supported formats: PDF, JPEG, PNG, GIF, WebP, DOC, DOCX. The format is detected server-side from the file's magic bytes, and non-image inputs are converted to an image before classification.

documentBase64

string

length ≥ 1

Base64-encoded document. API Gateway caps the request body at ~6 MB. Required when documentUrl is not supplied; do not send both.

documentUrl

uri

Publicly accessible URL the server can GET the document from. Required when documentBase64 is not supplied; do not send both.

candidateName

string

length ≥ 1

Candidate name. Only consulted when the validation list contains CHECK_NAME_MATCH; safe to omit otherwise.

documentType

object

required

Inline document type definition. Mirrors the DocumentType resource shape. Supply at least one of validation or classificationRules so the classifier has something to evaluate against.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

401

500