404. You can check caps.canViewSignerAssignments in the session payload before calling these routes.
List your signing packages
Returns all signing packages you are assigned to as a signer, together with the parent signing rows. Results are ordered by most recently updated first and capped at 100 entries each.Response
Your signer stub rows. Each object contains the fields below.
The parent signing package records for all packages in the
signers list, deduplicated. Ordered by most recently updated first.Error responses
| Status | Condition |
|---|---|
404 | No signer assignment is linked to your account. Contact your manager to be assigned. |
Get one signing package
Returns the full signing package record for a single package you are assigned to.Numeric ID of the signing package (as a string, e.g.
"3001").Response
The signing package record for this package.
Error responses
| Status | Condition |
|---|---|
400 | signingId is not a valid numeric ID. |
404 | You are not assigned as a signer to this package, or the package does not exist. |
List documents in a signing package
Returns all documents in the package, ordered byposition ascending then by id ascending. Capped at 500 documents.
Numeric ID of the signing package.
Response
Array of document records for this package.
Error responses
| Status | Condition |
|---|---|
400 | signingId is not a valid numeric ID. |
404 | You are not assigned to this package. |
Get one document
Returns a single document row from a package you are assigned to.Numeric ID of the signing package.
Numeric ID of the document.
Response
The document record for the requested document.Error responses
| Status | Condition |
|---|---|
400 | Invalid signing or document ID. |
404 | You are not assigned to this package, or the document does not exist within it. |
Record an e-signature
Records that you have electronically signed a specific document in a package. This is the primary signing action in the signer flow.Numeric ID of the signing package.
Numeric ID of the document to sign.
This endpoint is idempotent. The
e_sign_recorded_at timestamp on your signer row is written only on the first successful call. Subsequent calls for the same document return ok: true with firstESign: false and the same observedAt time from the first signing event—you will not receive an error.Request body
The request body is optional. Omit it entirely or send an empty object{}.
Optional metadata about the client environment at the time of signing.
x-forwarded-for header to capture the client IP for the audit record. Your API gateway or load balancer should set this header.
Response
Always
true on a successful call.true if this call recorded the e-signature for the first time. false if the document had already been signed by you previously (idempotent repeat call).ISO 8601 timestamp of when this signing event was observed by the server.
The updated document record after the signing action, or
null if the document could not be re-fetched.Your updated signer record for this package, reflecting the new status and timestamps, or
null if the signer record could not be re-fetched.true if a vault integration event was triggered for downstream processing. false if the signing package’s organization could not be resolved — the e-signature is still recorded regardless.Error responses
| Status | Condition |
|---|---|
400 | Invalid signing or document ID, or malformed JSON body. |
404 | You are not assigned to this package, or the document does not exist within it. |
List co-signers on a package
Returns all signer records on the same package. Useful for displaying the signing status of other parties in the transaction. Ordered by signer number ascending, capped at 200 entries.Numeric ID of the signing package.
Response
All signer records for this package, including your own record and all co-signers.
Error responses
| Status | Condition |
|---|---|
400 | signingId is not a valid numeric ID. |
404 | You are not assigned to this package. |
Get one co-signer
Returns a single signer record from the package.Numeric ID of the signing package.
Numeric ID of the signer row to fetch.
Response
The signer record for the requested signer.Error responses
| Status | Condition |
|---|---|
400 | Invalid signing or signer ID. |
404 | You are not assigned to this package, or the signer does not belong to this package. |
