Request a document
⚠️ Early access — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and reach out before building on it.
Request an official document for a registration, identified by exactly one of palm_id, registration_jurisdiction with registration_number, or business_id. The request is accepted immediately and fulfilled asynchronously: poll it, or subscribe to the document_request.processing, document_request.completed and document_request.failed webhook events. A business is added to your portfolio for the registration when none exists yet. Unsupported jurisdictions and entity types are refused at creation.
In test mode no state order is placed: the request moves through processing and completes with a sample certificate, or fails as directed by metadata._simulate.
Authorizations
Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx
Body
Document type to request.
certificate_of_good_standing "certificate_of_good_standing"
Palm ID of the registration. Provide exactly one of this, registration_jurisdiction with registration_number, or business_id.
"4604-3477-1850"
Registration jurisdiction in ISO 3166-2 format (e.g., US-DE, US-CO, US-WY)
"US-DE"
The registration's number in that jurisdiction
"7286832"
A business already in your portfolio.
"987e6543-e21a-45b6-c789-012345678901"
Expedited processing tier. Omit for standard processing. GET /v1/document-request/fee lists the tiers a state offers (expedited_tiers); a tier the state does not offer returns 400.
"expedited"
Up to 50 custom key-value pairs, echoed back on the resource. In test mode, the reserved key _simulate set to failed:<reason> ends the request as failed with that reason (jurisdiction_declined, entity_not_found or cannot_fulfill). Without it, a test request completes with a sample certificate. Ignored in live mode.
Response
Document request accepted
Unique identifier for the resource
"123e4567-e89b-12d3-a456-426614174000"
Object type
document_request "document_request"
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.
test, live "live"
ISO 8601 timestamp of when the resource was created
"2025-10-24T10:30:00Z"
ISO 8601 timestamp of when the resource was last updated
"2025-10-24T15:45:00Z"
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.
Requested document type
certificate_of_good_standing Current status
queued, processing, completed, failed Business the request and its documents attach to.
"987e6543-e21a-45b6-c789-012345678901"
Palm ID of the registration the request resolved to.
"2735-1926-5317"
Jurisdiction of the registration (ISO 3166-2).
"US-DE"
Documents delivered by this request, stored on the business record. Empty until delivery.
The registration's number in that jurisdiction.
"7086953"
Expedited processing tier requested, or null for standard processing.
"expedited"
Why the request failed. Populated on failed, null otherwise.
jurisdiction_declined, entity_not_found, cannot_fulfill, null ISO 8601 timestamp of when the request reached a terminal status, null while in flight.
"2026-10-08T16:22:06Z"

