Besides the overall document status, you can find out how individual people stand — who has already signed or approved, and who is still being awaited.
Listing signers
curl -H "x-api-key: VAS_API_KLIC" \
https://api.signi.com/api/v2/contract/ID_DOKUMENTU/signIdentities/list
What you get back — one item per person:
[
{
"docs_person": {
"email": "vas@email.cz",
"firstname": "…", "lastname": "…",
"docs_role": "proposer"
},
"contract_role": "approve",
"state": "not approved"
},
{
"docs_person": {
"email": "protistrana@email.cz",
"firstname": "Jan", "lastname": "Novák",
"docs_role": "counterparty"
},
"contract_role": "sign_type_a",
"state": "not signed"
}
]
The example is shortened — the items also carry other attributes, including the status and docs_person.status states described below.
Key fields:
- state — the state of the given person:
signed/not signed,approved/not approved,stamped/not stamped. - docs_person.status — the state of the party within the envelope:
new,waiting,waiting_to_assign,ready,completed,rejected(rejected= the party rejected the document). - status — the state of the signature itself:
new,ready,signed,completed. - docs_role —
proposerorcounterparty. - contract_role — signing role; the value
sign_type_ais the internal designation of the commonsignrole.
Recommendation for integrations: do not treat an unknown state value as an error — just log it. The enumerations of states may be extended in the future.
The reverse view: documents of a given signer
All documents in which a specific person appears can be listed with:
curl -H "x-api-key: VAS_API_KLIC" \
"https://api.signi.com/api/v1/contract/list/signer?email_signer=jan@email.cz&state=completed"
{ "contracts": [ { "id": 1234567, "state": "completed", "file_deleted": 0 } ] }
The state parameter is an optional filter (completed / draft / expired / pending).
Where to go next
- Document lifecycle — the overall document status
- Webhooks — completion notifications without polling
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article