Kdo už podepsal (API)

Kromě celkového stavu dokumentu můžete zjistit, jak jsou na tom jednotliví lidé — kdo už podepsal či schválil a na koho se čeká.

Výpis podepisujících

curl -H "x-api-key: VAS_API_KLIC" \
  https://api.signi.com/api/v2/contract/ID_DOKUMENTU/signIdentities/list

Co se vrátí — jedna položka za každého člověka:

[
    {
        "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"
    }
]

Ukázka je zkrácená — položky nesou i další atributy, mj. stavy status a docs_person.status popsané níže.

Klíčová pole:

• state — stav daného člověka: signed / not signed, approved / not approved, stamped / not stamped.
• docs_person.status — stav strany v obálce: new, waiting, waiting_to_assign, ready, completed, rejected (rejected = strana dokument odmítla).
• status — stav samotného podpisu: new, ready, signed, completed.
• docs_role — proposer (navrhovatel) nebo counterparty (protistrana).
• contract_role — podpisová role; hodnota sign_type_a je interní označení běžné role sign.

Doporučení pro integrace: neznámou hodnotu stavu neberte jako chybu — jen ji zalogujte. Výčty stavů se mohou v budoucnu rozšířit.

Opačný pohled: dokumenty daného podepisujícího

Všechny dokumenty, kde figuruje konkrétní člověk, vypíše:

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 } ] }

Parametr state je volitelný filtr (completed / draft / expired / pending).

Kam dál

• Životní cyklus dokumentu — celkový stav dokumentu
• Webhooky — hlášení o dokončení bez dotazování