v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Interview

Fetch onboarding status

Check the status of onboarding session.

get/omni/get/onboarding/status

Query parameters

idstring

Represents interview id for which status is requested. If it is not present it will be read from token.

Headers

api-versionstring required

Response

onboardingStatus: String. A flag indicating current status of onboarding session. Possible values:

  • ID_VALIDATION_FINISHED - User finished with capturing of ID,
  • POST_PROCESSING_FINISHED - ID postprocessing finished on server,
  • FACE_VALIDATION_FINISHED - User finished with selfie capture,
  • ONBOARDING_FINISHED - User finished onboarding process,
  • MANUAL_REVIEW_APPROVED - Session that was in Needs Review state, manually approved by Executive,
  • MANUAL_REVIEW_REJECTED - Session that was in Needs Review state, manually rejected by Executive,
  • UNKNOWN - Unable to determine status of onboarding session - user still didn't start onboarding or user is still in the process of capturing ID.
object required