Skip to main content
POST
Cancel a document request

Authorizations

Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

document_request_id
string<uuid>
required

Document request ID

Example:

"0f6b2d84-5a31-4c97-8e42-6d1a9f3b7c58"

Response

Document request canceled

id
string<uuid>
required

Unique identifier for the resource

Example:

"123e4567-e89b-12d3-a456-426614174000"

object
enum<string>
required

Object type

Available options:
document_request
Example:

"document_request"

mode
enum<string>
required

Whether this resource was created with test or live credentials. Test and live data are fully isolated — a test resource never appears in live results and vice versa.

Available options:
test,
live
Example:

"live"

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created

Example:

"2025-10-24T10:30:00Z"

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated

Example:

"2025-10-24T15:45:00Z"

metadata
object
required

Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.

Example:
type
enum<string>
required

Requested document type

Available options:
certificate_of_standing
status
enum<string>
required

Current status

Available options:
queued,
processing,
completed,
canceled
business_id
string<uuid>
required

Business the request and its documents attach to.

Example:

"987e6543-e21a-45b6-c789-012345678901"

palm_id
string
required

Palm ID of the registration the request resolved to.

Example:

"2735-1926-5317"

registration_jurisdiction
string
required

Jurisdiction of the registration (ISO 3166-2).

Example:

"US-DE"

documents
object[]
required

Documents delivered by this request, stored on the business record. Empty until delivery. A request the jurisdiction refused to fulfill delivers what it returned, such as its refusal or fee receipt. Check each document's types for certificate_of_standing to tell a delivered certificate from a refusal. Retrieve the certificate at GET /document/:id: its metadata.certificate_name is the jurisdiction's own name for it, such as Certificate of Status, and its metadata.issued_date is the date printed on it, each when known.

registration_number
string | null

The registration's number in that jurisdiction.

Example:

"7086953"

expedited_tier
string | null

Expedited processing tier requested, or null for standard processing.

Example:

"expedited"

completed_at
string<date-time> | null

ISO 8601 timestamp of when the request completed, null until then.

Example:

"2026-10-08T16:22:06Z"

status_reason
string | null

Why the request was canceled: partner_requested when you canceled it, parent_filing_canceled when the foreign qualification that ordered it was canceled, or the reason Palm wrote when Palm canceled it. null unless canceled.

Example:

"partner_requested"

canceled_by
enum<string> | null

Who canceled the request: partner (you) or palm. null unless canceled.

Available options:
partner,
palm,
null
Example:

"partner"

canceled_at
string<date-time> | null

ISO 8601 timestamp of when the request was canceled, null unless canceled.

Example:

"2026-10-08T16:22:06Z"