Webhooky ověření

ℹ️ Nová verze Signi ověření (včetně tohoto API) bude na produkci zveřejněna v průběhu září 2026. Do té doby volání nejsou dostupná a popis se může drobně změnit.

O změnách stavu ověření se váš systém dozví webhooky ověření. Jsou to jiné webhooky než ty dokumentové — mají vlastní události a navíc podepisují zprávy (HMAC), abyste si mohli ověřit, že opravdu přišly od Signi.

Události

verification.started, verification.completed (kontroly dokončeny, čeká na schválení), verification.approved, verification.rejected, verification.declined, verification.expired, verification.abandoned.

Přihlášení k odběru

Webhooky se zadávají při založení ověření nebo navázání na dokument, polem webhooks:

"webhooks": [
    { "event": "verification.approved", "url": "https://vase-aplikace.cz/overeni-schvaleno" },
    { "event": "verification.rejected", "url": "https://vase-aplikace.cz/overeni-zamitnuto" }
]

• Adresa musí být HTTPS a veřejně dosažitelná.
• Na každou událost nejvýše jeden odběr; jiné klíče než event a url volání odmítne.

V odpovědi se ke každému odběru vrátí secret — klíč pro kontrolu podpisu zpráv:

"webhooks": [
    { "event": "verification.approved", "url": "https://vase-aplikace.cz/overeni-schvaleno", "secret": "…" }
]

Pozor: secret se vrací jen jednou, právě tady. Uložte si ho hned — znovu ho z API nedostanete.

Výchozí webhooky workspace

Workspace může mít nastavené výchozí odběry. Chování pole webhooks:

• vynecháte ho — na ověření se zkopírují výchozí odběry workspace (používají dlouhodobý sdílený klíč workspace, který se v odpovědi nevrací — odpověď je prázdná),
• pošlete [] — žádné odběry, ani výchozí,
• pošlete vlastní seznam — registrují se přesně tyto odběry s čerstvými klíči v odpovědi.

U recyklovaného ověření (reused: true) se žádné nové odběry neregistrují.

Kam dál

• Signi ověření — jak funguje