Platform user guide
KYC and AML in the dashboard
The workspace for customer verification.
The KYC/AML section is the workspace for customer verification. Incoming sessions appear here, their history is stored here, and here you set up verification scenarios and create links for passing KYC.
Tabs
| Tab | What it holds |
|---|---|
| KYC Logs | Incoming sessions as they arrive. |
| KYC Reports | The history of all sessions, with filters, export and deletion. |
| KYC Editor | Verification scenarios. Visible to users who may edit scenarios. |
| KYC Links | One-time links for passing KYC. |
| Questionnaires | Questionnaire records. The tab appears once there is at least one link to a questionnaire scenario. |
Logs and reports header
Above the session list on the logs and reports tabs you find:
- The scenario list, to show the sessions of one scenario or all scenarios.
- The + button, to create a session manually. Choose a scenario and a new session of it appears, for example to test the scenario.
- The KYC SDK button, to open the widget right in the dashboard for the selected scenario and go through the check yourself.
- The button that deletes all sessions, shown to users with the right to delete sessions.
If there are no scenarios yet, the lists contain only "Create new KYC process", which leads to creating a scenario.
KYC Logs
New sessions appear on the logs tab immediately, without reloading the page. Each card is one session assembled by its scenario: documents, selfie, liveness, in the set the scenario defines. Clicking the session date copies its identifier.
The session status is shown on the card: waiting, success, failed, expired, suspicious or processing. The status can be changed by hand after a confirmation. What each status means is described in session statuses, and the call is change session status.
The session menu offers: edit the scenario, copy the session link, delete the session after a confirmation, and get client data.
The tabs of a session card depend on the steps of the scenario:
| Tab | What it shows |
|---|---|
| Document | The recognized type, the document fields and the results of the authenticity checks: the machine readable zone and its checksums, signs of a photo taken from a screen, a photocopy, a printout or a graphical editor, and the presence of a signature and a stamp. |
| Selfie | The image of the customer, with the document in hand if required. |
| Faces | Whether the face on the selfie matches the document photo. |
| Liveness | The result of the liveness check. |
| Address proof | A utility bill or a bank statement. |
| Databases | Database checks, such as AML screening, if they are enabled in the scenario and available to your account. The re-run button runs the check again, and a re-run is billed as a separate request. |
| Questionnaire | The questionnaire data and the result of matching against it, if a questionnaire is linked to the session. |
| JSON | The full session result. |
Until the session status is success, an image can be uploaded to the session.
Blacklist. To make the face of a customer block their later sessions, click the blacklist icon on the image in the selfie tab and confirm. For this the scenario settings must have a faces black list selected. Otherwise the dashboard asks you to choose one.
KYC Reports
The reports tab holds all sessions. Unlike the logs, the list does not update by itself. It is meant for search, analysis and export.
- Filters: by dates (the period the session was created in), by value (recognized data such as full name or document number, and the client key), by status and by errors (the rejection reason).
- Export: filter the sessions, click Download report, choose CSV or XLS and download. The archive can be downloaded once. After the download it is deleted from the server. To get it again, repeat the export. The API does the same with filter sessions and download logs archive.
- Deletion: a session can be deleted from its menu, and all sessions of the current selection with the delete-by-filter button. Only users with the delete permission can do it.
KYC Editor: scenarios
A scenario defines what the customer goes through (documents, selfie, liveness, questionnaire) and which checks apply. The editor shows the list of scenarios and the buttons to create one from a template or from scratch. A scenario can be edited, duplicated, copied to the clipboard, have its identifier copied, or be deleted. Deleted scenarios are shown in a separate list.
A scenario is configured on the tabs Verification steps, General options, Callback options, Web SDK Settings and Integration Docs. Save needs a name and at least one step.
Verification steps
Steps run in the order set. For each step choose what the customer uploads and enable the checks you need.
- Document step. Choose the document type and the allowed countries. Enable the checks, whose set depends on the document type: the document is fully visible, the machine readable zone is processed, a photo taken from a screen, a photocopy or a printout, a graphical editor, corrected fields, logical mismatches, a pasted-in photo, a damaged document, signatures and stamps. Database checks are listed here if they are available to your account. Read the verdicts of these checks separately, see AML screening.
- Selfie step. A selfie, or a selfie with the document from the previous step. Checks: the image is not edited or taken from a screen, the age and gender of the customer by face, a deepfake check, and blocking sessions with other faces in the frame.
- Liveness step. Checks that a live person is in front of the camera. Recording a video of the check is enabled separately.
- Questionnaire step. The customer fills in the fields of a questionnaire. See two-stage questionnaire then KYC.
General options
- Scenario ID, the identifier passed to the API and the Web SDK.
- Secret key, which encrypts notifications to your server and the client key. The Check button opens a window where a client key can be encrypted or decrypted. See working with clientKey.
- The mobile redirect addresses on success and on error.
- Client faces list, a list from the person lists that verified customers are added to for later search.
- Faces black list. If the face of the customer matches this list, the session is blocked.
- A required face match with a reference session.
- The number of critical errors before the session is blocked. It protects against brute-forcing forged images. Zero means no limit.
- Session data retention in days. Zero means indefinitely.
- Session TTL, the time the customer has to complete the session, from minutes up to a year.
- Allowed age, a range taken from the date of birth in the document.
- Flags for the document steps, such as blocking the session when two different documents are detected in one step.
Callback options
A callback is a notification the platform sends to your server about the progress and result of a session. Enter the backend callback URL and use the test request to check that the address is reachable. Flags: encrypt the POST body with the secret key, omit identity fields, notify only when the session is finalized, and send database checks. What the option that omits identity fields leaves out differs per event, see receiving webhooks. The database checks event is one notification with the full result set, sent once all checks of the session are terminal.
See webhooks for the events and the options.
Web SDK settings
The look of the widget for this scenario: the color theme, a preview in mobile and desktop modes, the logo separately for the dark and the light theme, the links to the terms of use and the privacy policy, the permission to use a desktop camera, the colors, the texts of the screens, and the languages. The widget has 29 interface languages. See the Web SDK.
Integration docs
Ready-made examples of connecting the widget for the scenario, and examples of client key encryption. Also see the integration guides.
KYC Links: one-time links
A link lets a customer pass KYC without any integration on your side. Send it to the customer and they complete the scenario in the browser.
- Choose the scenario.
- Choose the validity period of the link, from 15 minutes to 30 days.
- Set the number of links, from 1 to 1000.
- Optionally, with one link, set a client key to tie the session to the customer in your system.
- Optionally, with one link and existing questionnaires, bind a questionnaire record. The document data is then matched against that questionnaire.
- Click Generate links.
The list of links shows the link, the scenario, the creation time, the expiration time, whether it was opened, and the status. You can filter it by status, by scenario and by opened, show expired links, and copy or delete selected links.
Questionnaires
The tab shows questionnaire records: the session identifier, the creation date, the status, the full name and the date of birth, the client user, the KYC sessions where the questionnaire was used, the database checks and the JSON of the record. See two-stage questionnaire then KYC.