NUnumeral-com

List Certificates

Changed on

Retrieve a paginated list of exemption certificates. Filter by customer, jurisdiction, status, certificate type, and time windows. Live-only.

get/tax/certificates

Request

  • Base URL
    https://api.numeralhq.com
  • URL
    https://api.numeralhq.com/tax/certificates
  • Auth
    HTTP bearer

Query parameters

status'processing' | 'needs_info' | 'active' | 'expiring' | 'expired' | 'invalid'

Public lifecycle state of an exemption certificate. expiring and expired are distinct from invalid so a renewable lapse is distinguishable from a revoked or rejected certificate.

customer_idstring
id_type'id' | 'reference_customer_id'

How to interpret customer_id. Use id (the default) for the Numeral cust_* id, or reference_customer_id for your own id. Validated whenever present — passing an unknown value returns INVALID_REQUEST (400) even if customer_id is not also supplied.

jurisdictionstring

Jurisdiction identifier, e.g. US-CA.

certificate_type_idstring

Filter by certificate type. Accepts either the stable identifier (e.g. US-CA-CDTFA-230) or the numeric type id (e.g. 12).

created_afterstring date-time
created_beforestring date-time
updated_afterstring date-time
updated_beforestring date-time
limitinteger
cursorstring

Headers

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

Response

Certificate list

object'list' required
has_moreboolean required

Whether there are more certificates to fetch.

next_cursorstring

Pass as cursor on the next request. Omitted (not null) on the final page.

Example response

{
  "certificates": [
    {
      "id": "cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e",
      "object": "tax.exemption_certificate",
      "certificate_type": {
        "id": "12",
        "name": "California Resale Certificate (CDTFA-230)",
        "certificate_identifier": "US-CA-CDTFA-230"
      },
      "customer": {
        "id": "cust_6126acaf-7379-411a-8ada-00005bac0715",
        "reference_customer_id": "20506",
        "name": "Acme Co"
      },
      "linked_buyer": {
        "id": "12345",
        "legal_name": "Acme Co"
      },
      "jurisdictions": [
        {
          "jurisdiction_id": "US-CA"
        }
      ]
    }
  ]
}

Changes

  • f4650eaed11fRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status