Docparser.dev Docs

Documentation search

Find an answer

Start typing to search the documentation.
    Back to website Open portal

    Available

    API reference

    Public Docparser endpoints for asynchronous document submission and persisted job retrieval.

    Updated 2026-07-28

    The public API base URL is https://app.docparser.dev/api/v1. Requests and responses use JSON over HTTPS.

    Endpoints

    MethodPathPurpose
    POST/documentsValidate a single, multi-image, or email-attachment request; persist a job; enqueue extraction; and return 202 Accepted.
    GET/documents/:consumerRefIdReturn the first persisted job row matching the authenticated organization and supplied consumer reference.

    Both endpoints require the x-client-id and x-client-secret headers described in Authentication.

    Asynchronous lifecycle

    Submission returns a jobId and echoes consumerRefId; it does not wait for extraction. A job can move through initiated, extracting, classifying_email_content, extracting_from_attachments, processed, error. Receive the completed extraction at the API key’s registered webhook base URL plus the request’s relative webhookUrl, or poll the retrieval endpoint.

    Document types

    The submit endpoint accepts these live type IDs for single and multi-image jobs: 0 (Invoice), 1 (Purchase Order), 2 (GRN), 3 (Debit Note), 4 (Credit Card Statement), 5 (Credit Card Statement (multi-account)), and 9 (PO number only). Email attachment mode is inferred from attachments and is not selected with a public typeId.

    Naming conventions

    Request bodies and the persisted row returned by GET use camelCase. Webhook payload identifiers use snake_case, such as consumer_ref_id and document_id. The submit reference shows the boundary explicitly.