On Flow Ended | INFONITE

Triggered when the verification flow finishes. If an aes_key was provided during Create Session, the extraction results inside the data payload will be delivered encrypted in aes::Base64(IV + Ciphertext + Tag) format.

Encrypted Payload

If you configured an aes_key, this payload is encrypted. View step-by-step decryption walkthrough and code templates in the Payload Encryption guide.

If no aes_key was specified, the data payload is omitted (null), and you must retrieve the results manually using the session API.

This is the one that means finished

The payload of this event carries is_closed: true. That field — not the arrival of any webhook, not the widget closing, not a WAITING status — is what tells you a session is over and its results are final.

If you also subscribe to On Partial Results, you will have seen the same session earlier with is_closed: false. Branch on that field and you cannot get it wrong.

Triggered when the verification flow finishes. If an `aes_key` was provided during [Create Session](api:POST/es-public-administration/v1/manager/init), the extraction results inside the `data` payload will be delivered encrypted in `aes::Base64(IV + Ciphertext + Tag)` format. <Card title="Encrypted Payload" icon="fa-solid fa-key" href="/payload-encryption"> If you configured an `aes_key`, this payload is encrypted. View step-by-step decryption walkthrough and code templates in the **Payload Encryption** guide. </Card> If no `aes_key` was specified, the `data` payload is omitted (null), and you must retrieve the results manually using the session API. <Note title="This is the one that means finished"> The payload of this event carries **`is_closed: true`**. That field — not the arrival of any webhook, not the widget closing, not a `WAITING` status — is what tells you a session is over and its results are final. If you also subscribe to [On Partial Results](api:POST/es-public-administration:partial), you will have seen the same session earlier with `is_closed: false`. Branch on that field and you cannot get it wrong. </Note>

Payload

The payload of this webhook request is an object.

event_class"EsPublicAdministrationV1FlowEvent"Required

Payload class discriminator — always this value for Spain Public Administration events.

app_idstringRequiredformat: "ObjectId"

customer_idstringRequired1-64 characters

session_idstringRequiredformat: "ObjectId"

producer"es-public-administration"Required

The flow that produced the event.

event"es-public-administration:ended"Required

The event type: ended.

status_codeenumRequired

Base status codes for widget flows Allowed values are:

READY: The flow is waiting for an input
WAITING: Flow is waiting for an external event
COMPLETED: The flow has finalized successfully
FAILED: The flow has failed
SYSTEM_CANCELLED: The flow has ben cancelled by the system
CLIENT_CANCELLED: The flow has been cancelled by the client
CUSTOMER_CANCELLED: The flow has been cancelled by the customer
TIMED_OUT: The flow has timed out
CONFIGURATION_ERROR: The flow has been rejected due to a configuration error

datestringOptionalformat: "datetime"

status_messagestring or nullOptional

dataobjectOptional

Verification results payload.

On success (COMPLETED):
- If an aes_key was provided during session creation, the results are delivered encrypted. Please refer to the Payload Decryption section of the API introduction to decrypt them into FlowResultsSchema.
- If no aes_key was specified, this field is not informed (null), and you must retrieve the results manually using the session API.
On cancellation or failure, it contains error/feedback details conforming to WebhookEndedErrorPayload.

Response

200

Successful Response

422

Validation Error