Cancel a document request
⚠️ 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.
Cancel a document request before Palm starts the order.
When it succeeds. The request must still be queued. It moves to the terminal canceled status, a document_request.canceled webhook fires, and the response returns the request with status_reason partner_requested, canceled_by partner and canceled_at set.
When it fails. Once the request is processing (or finished), cancellation returns a 409 document_request_not_cancellable problem whose current_status member carries the status the decision was made against. A refused cancel on a request in progress still reaches the Palm team working it, so they know you asked to stop. A request a foreign qualification ordered is canceled by canceling that filing: canceling the request itself returns the same 409, with the filing in filing_id.
Canceled by Palm. Palm can also cancel a request it cannot fulfill, before or during the order. The request moves to canceled with canceled_by palm and the reason in status_reason, and the same webhook fires. A request a foreign qualification ordered is canceled with status_reason parent_filing_canceled when that filing is canceled before Palm starts the order.
Fees. A canceled request is not billed.
In test mode a queued request can be canceled the same way.
Authorizations
Path Parameters
Response
Document request canceled
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.

