Skip to main content
GET
Get Certificate Request

Get Certificate Request (2026-03-01)

Retrieve the details of a specific certificate request by its cert_req_* id.
Remember to include the X-API-Version: 2026-03-01 header. Certificate-request endpoints are live-only — using a sk_test_* key returns TESTMODE_NOT_SUPPORTED. Requests outside your account return CERTIFICATE_REQUEST_NOT_FOUND (404) — Numeral never leaks the existence of another tenant’s resources.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
enum<string>
required
Available options:
2026-03-01

Path Parameters

request_id
string
required

Response

Certificate request

A single certificate request.

id
string
required

The ID of the certificate request

Example:

"cert_req_b2f1e4a3-9c0d-4e7a-8b1f-2d5a6e7b8c9d"

object
string
required

The type of object: tax.certificate_request

Example:

"tax.certificate_request"

status
enum<string>
required

Public lifecycle state of a certificate request. The internal status enum is narrower in the public vocabulary on purpose — processing collapses to pending, failed collapses to invalid.

Available options:
pending,
fulfilled,
canceled,
invalid
customer
object | null
required

The specific Customer record linked to this request. null when no live Customer has been associated yet (a master buyer may still be present — see linked_buyer).

linked_buyer
object | null
required

The master buyer entity that owns this request. Populated whenever the request has a master-buyer reference, even when no Customer record has been linked yet. Prefer this over customer for rendering "who owns this request".

certificate_id
string | null
required

Populated only when status === "fulfilled". The cert_* id of the submitted certificate.

Example:

"cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e"

certificate_type_id
string | null
required

Stable identifier of the requested certificate type, e.g. US-CA-CDTFA-230.

Example:

"US-CA-CDTFA-230"

jurisdictions
string[]
required

Jurisdiction identifiers covered by the request.

Example:
created_at
string<date-time>
required
updated_at
string<date-time>
required
expires_at
string<date-time> | null
required

When the request will auto-expire if not fulfilled. null if the request does not auto-expire.

livemode
enum<boolean>
required

Always true — these endpoints are live-only.

Available options:
true