Skip to main content

Global Overview of the Technical Structure

Domain Terms​

When using the API, you'll come across a few domain terms that are handy to know:

  • Flow: A validation flow that a professional clicks through in order to validate themselves. Screening and validation are used as synonyms for a flow.
  • Check: A step within a flow (a flow contains multiple checks). For example: ID check, IBAN check, diploma check, etc.
  • Professional: The person being validated/screened
  • Recruiter: The person or organization requesting the validation

Global Process of Validation​

The simplest sequence in order to validate a professional would be as follows:

  1. Create a new flow using POST /validation-flow
  2. Two options for inviting the professional:
    • We send the professional an invite
    • You communicate the URL of the screening to the professional
  3. The professional completes all checks within the flow
  4. If you provided a webhook URL: we will call the webhook when status changes
  5. You poll the API to get the status and information of the flow

Validation Flow Lifecycle​

Key Concepts​

Importance Levels​

Each check in a flow has an importance level:

  • SKIPPABLE: Professional can skip this check if unable to complete
  • NOT_SKIPPABLE: Professional must complete this check to proceed
warning

Making a check NOT_SKIPPABLE can block professionals who have legitimate reasons for not completing it. For example, older or foreign diplomas may not be available in DUO.

Verification Status​

Each piece of data collected can have different verification statuses:

  • Verified: Data has been validated through official sources (e.g., iDIN, DUO)
  • Unverified: Data provided by the professional but not validated
  • Cross-referenced: Data matched against other verified sources