Products
Questionnaire
Collect the details you need first, then verify the person in a second stage.
What it does
Some services need details that no document carries, or need them before the identity check starts. The questionnaire is a form step that runs before the KYC. It collects the name, the birth date, the email and the phone number, and it can hold custom fields that you define.
How it works in the flow
- Stage one: the form. The user fills in the questionnaire. The record stays
idleuntil it is filled in and committed, and then it becomessuccess. - The event. The
QUESTIONNAIRE_COMPLETEwebhook tells your backend that the form is committed. - Stage two: the verification. The full KYC session follows, with the document and face steps of your scenario.
What your system receives
The questionnaire record with its status, and the event that announces it. The session of the second stage is read like any other. See session statuses and webhooks.
Set it up
The questionnaire is a step in the scenario editor. Choose it for the flows that need the form first.
Use it
The two-stage questionnaire then KYC use case describes the whole journey.
Next
Read the quick start for the call sequence of a normal session.
Questions, answered plainly
What does the questionnaire collect?
Name, birth date, email, phone and custom fields that you define.
What happens after the form is filled in?
The QUESTIONNAIRE_COMPLETE webhook tells your backend the form is committed, and the full KYC follows.
What status does a questionnaire record have?
A questionnaire record is either idle, while the form is unfinished, or success, once it is filled in and committed.
Can I use the questionnaire on its own?
It is a pre-KYC step. The flow is a questionnaire stage first and the full verification second.