Reconcile contract request
Manually triggers a status sync for a contract request, fetching the latest
signing status from the document signing provider.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Manually triggers a status sync for a contract request. The endpoint fetches the latest signing state from the signing provider, replays any new signer and submission events to advance the request, and returns the updated contract request. Use it to recover a request whose status looks stale when a provider webhook was missed or delayed.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.requests.reconcilepermission and have the OWNER or OPERATIONS role. - The client must have contract signing enabled. If signing is disabled for the client the request returns
403.
Path parameters
request_id(string, required) — ID of the contract request to reconcile. Must belong to your client.
Preconditions
- The contract request must already have a signing submission to reconcile against. A request that was never sent for signing has no submission id and is rejected with
400.
What reconciliation does
The endpoint reads the current submission from the signing provider and applies its state to your request:
- Each signer that has opened, started, viewed, completed, or declined since the last sync is replayed so the corresponding participant status advances.
- When the submission as a whole is
completed,archived, orexpired, the request is moved to its terminal state (completed documents and audit log become available once all stages finish). - Otherwise the stored submission reference is refreshed and the request is advanced to reflect the latest in-progress signer.
The operation is safe to call repeatedly; events already applied do not double-advance the request.
Response
200 — Returns the updated ContractRequestResponse reflecting the reconciled state, including status, current_stage_index, current_participant_key, active_signing_url, the full participants list with per-signer status, and, once finished, completed_document_url and audit_log_url.
Error responses
| Status | When |
|---|---|
400 | The contract request has no signing submission to reconcile |
403 | Contract signing is disabled for the client |
404 | No contract request with this request_id exists under your client |
502 | The signing provider returned an invalid submission payload |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.