Skip to main content
A decision webhook is sent to the API key’s configured decision URL when Helium ID reaches a terminal outcome for an individual verification session. Today, the terminal decision events are:
  • verification.successful
  • verification.failed
The current session status is also available when you fetch the verification with GET /v1/verifications/{id}.

​
Fetch decisions

There are several options to fetch the decision(s) of a verification session:
  • Manually: the Verifications page in the Helium Id Dashboard
  • Check the decision webhook payload: configure a webhook URL in your dashboard to receive automated updates.
  • Query the API: Use the GET /v1/verifications/{id} endpoint to fetch the current status.

​
What a decision means

For most integrations, the important end states are: You may also encounter in-progress states such as not started and started when fetching the session before a terminal outcome is available.

​
Verification session lifecycle

A session decision is returned after the end-user’s data has been analyzed and Helium ID has reached a conclusion. The lifecycle generally follows this path:
  1. Created: You generate a new session via API or Dashboard.
  2. Started: The user enters the flow and provides their document images and selfie.
  3. Processed: Helium ID evaluates the submitted data.
  4. Decision reached: the session becomes successful or failed.
If you need richer progress signals before the final outcome, configure your events webhook URL as well. Progress events such as verification.started and verification.processing_started are sent there, while terminal decisions are sent to the decision webhook URL.