ScreenlyyIDDocs
screenlyyid.comDashboard
Docs › Getting started

How it works

A full onboarding integration with a mobile or web application has three steps.

  1. Create a session. Call the Instance API. It returns a correlation ID, which acts as your session token.
  2. Collect the ID and selfie images. Choose how: the mobile app WebView, the web app integration, or a custom integration.
  3. Retrieve the results. Optionally fetch the OCR data and decision results in real time, to make decisions in your app or save them to your own database. See Data retrieval. Results are also always visible in the ScreenlyyID dashboard.

What you pass on every call#

HeaderValue
x-api-keyYour API key from the dashboard.
x-correlation-idThe correlation ID returned by the Instance API for this customer's session.

See Authentication for details.