Skip to content

Per-recipient signing status by document id

GET
/document/app/sign/status/{doc_id}/
curl --request GET \
--url https://app.qsig.in/backend/othercompanyapi/document/app/sign/status/1/ \
--header 'X-Api-Key: <X-Api-Key>'

Returns each recipient’s signing state for a document. Requires X-Api-Key, and the key must own the document. signed_doc_url is present once every recipient has signed. (This is the per-document status endpoint used by integrations such as the Salesforce package.)

doc_id
required
integer

Recipient statuses

Media type application/json
object
data
Array<object>
object
user_name
string
email_of_user
string
is_signed
boolean
is_rejected
boolean
rejection_reason
string
sequence
integer
signingCapacity
string
typeOfSignature
string
signed_doc_url

Present only when all recipients have signed

string
Example generated
{
"data": [
{
"user_name": "example",
"email_of_user": "example",
"is_signed": true,
"is_rejected": true,
"rejection_reason": "example",
"sequence": 1,
"signingCapacity": "example",
"typeOfSignature": "example"
}
],
"signed_doc_url": "example"
}

Missing or invalid API key

API key does not own this document

Document not found