A detailed guide on fetching scores, what other data can be obtained and how to interpret it can be found in: How to Fetch Results.

For this guide you are interested in how to actually call the API, in this two scenarios:

Initiated by the frontend

Used inRedirect and Back and Embedded Iframe.

In this scenario, the frontend is inquiring the backend what the result of the session is, you also take this opportunity to run any business logic needed on your side.

Just send the interviewId and the sessionToken to your backend and start by calling the Fetch scores API endpoint .

If the score.overall.status is OK, then you can run your custom logic like Fetch OCR Data, Fetch Device Information and Geolocation Data or Fetch Images.

See How to Fetch Results for a detailed explanation of the process and the meaning of all the returned values.

Your backend should return the minimal possible information to the frontend so it knows what to do, but not too much it could get you exposing sensible information.

Webhook

Used inURL Redirect

In this scenario the user finished the onboarding and a Webhook is sent to a endpoint you can define it in Getting Started on Webhooks, the one you want to setup is the Onboarding Status Webhook, in this webhook you are looking for the ONBOARDING_FINISHED status.

To get the score data you will need an Admin Token(you can get one by calling the Executive Login endpoint), and the interviewId you received in the Webhook. Then call the Fetch scores API endpoint .

From here you can run your custom logic like Fetch OCR Data, Fetch Device Information and Geolocation Data or Fetch Images.

See How to Fetch Results for a detailed explanation of the process and the meaning of all the returned values.