NUnumeral-com

List Certificate Uploads

Changed on

Retrieve a paginated list of certificate uploads, ordered by id ascending. Filter by status and customer. List items omit document_url — fetch a single upload for the document link. Live-only.

get/tax/certificate-uploads

Request

  • Base URL
    https://api.numeralhq.com
  • URL
    https://api.numeralhq.com/tax/certificate-uploads
  • Auth
    HTTP bearer

Query parameters

status'processing' | 'completed' | 'failed' | 'duplicate'

Processing state of a certificate upload. This is a separate vocabulary from certificate status — an upload is a processing job, a certificate is its output. processing is the only non-terminal state; completed (certificates produced), failed (see error_message), and duplicate (same document already submitted) are terminal.

Filter by upload status. Any other value returns INVALID_REQUEST (400).

customer_idstring

Filter to one customer. Interpreted per id_type. Matches only live, live-mode customers.

id_type'id' | 'reference_customer_id'

How to interpret customer_id. Use id (the default) for the Numeral customer id, or reference_customer_id for your own id. Any other value returns INVALID_REQUEST (400).

cursorstring

Pagination cursor — pass next_cursor from the previous response (an upl_* id; the bare numeric form is also accepted). Returns rows with an id greater than the cursor. Malformed values return INVALID_REQUEST (400).

limitinteger

Max items per page (1–100). Defaults to 10.

Headers

X-API-Version'2026-03-01' required

Must be 2026-03-01 or later. Older versions return INVALID_REQUEST (400).

Response

Certificate upload list

object'list' required
has_moreboolean required

Whether there are more uploads to fetch.

next_cursorstring

Pass as cursor on the next request. Present only when has_more is true.

Example response

{
  "certificate_uploads": [
    {
      "id": "upl_4471",
      "object": "tax.certificate_upload",
      "customer": {
        "id": "cust_6126acaf-7379-411a-8ada-00005bac0715",
        "reference_customer_id": "20506"
      },
      "certificate_ids": [
        "cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e"
      ]
    }
  ],
  "next_cursor": "upl_4471"
}

Changes