🗒️
Documentation
  • Platform Overview
  • Get Started
    • Using Platform APIs
    • Lifecycle of the Client
    • Get Financial data
  • Onboarding
    • Onboarding Overview
    • Phone Number Verification
    • Confirm Rules
    • Verify Individual Client
    • Financial Questionnaire
    • Soft Check
    • Waiting
    • Soft Check Decisions
    • Signing Credit Agreement
    • Credit Limit Increase
    • Consent for Marketing
    • Verify Selfie Liveness
    • Verify Documents
    • Proof of Address
  • Payments
    • Send Faster Payment
    • Top-up an account
    • Variable Recurring Payments
  • Credit
    • Overview
  • Cards
    • Overview
  • Platform Communications
  • Back-office processes
  • Mobile SDK
    • Android SDK
    • iOS SDK
Powered by GitBook
On this page
  • Quick reference
  • Definition of onboarding
  • The concept of steps
  • How to onboard User
  • Is it necessary to go through all of the steps?
  • Reference table for Steps
  1. Onboarding

Onboarding Overview

Quick reference

  1. Definition of onboarding

  2. The concept of steps

  3. How to onboard User

    1. Verify phone number

    2. Start registration

    3. Navigate User step-by-step

    4. Complete registration

  4. Is it necessary to go through all of the steps?

  5. Reference table for steps

Definition of onboarding

To create User account, Kavoon requires certain information. It must be provided in a sequence determined by Kavoon. The process during which this information shall be provided is called onboarding or registration. From User’s side, the process might look like an end to end journey in logical steps.

The concept of steps

Onboarding is broken into a row of steps (see the complete list). At each one, Client should react in a specific way. For instance,

  • at step ENTRY_DATASET, Client should collect minimal information about User and submit it to Submit entry data API

  • at RISK_SHORT – ask User about financial situation and send the answers to Submit financial quiz

  • at SELFIE_UPLOAD – get User’s self-portrait photograph (“selfie”) and send it to Upload a file.

Kavoon drives the logic of registration. It determines which step to direct User to in outputs of Get User State API, specifically in the parameter step.

Almost at each milestone, Kavoon receives information from Client, processes it (e.g. validates, uses for identity authentication, etc), saves to databases, and responses Client with what the next step is.

Note: steps and required reactions might change from time to time that will be updated in the documentation

How to onboard User

1. Verify phone number

Before requesting onboarding APIs, Client must acquire the first authentication factor – an access token. It will be granted as soon as User proves his phone number. To initiate such verification, Client shall invoke sending SMS text containing a one-time password (OTP) to User. For details, please refer to the detailed instructions.

2. Start registration

There are params status and step in Get User State’s response. Once status gets value "REGISTER", meaning that registration is in process, the parameter step starts holding the current registration step. Normally, the onboarding starts with step: "CONFIRM_RULES".

3. Navigate User step-by-step

Let’s say, you’ve called Verify Individual Client and there is "RISK_SHORT" in the response:

{
  "result": {
    "userInfo": {
      "status": "REGISTER",
      "step": "RISK_SHORT",
      "stepExtras": {}
    }
  }
}

That means that the previous step is completed, and you (client) should call the service that maps to "RISK_SHORT" step - SELFIE_UPLOAD.

step is already indicated not only in User State, but also in the service response. In addition, there is stepExtras with a group of additional parameters. It helps not to call User State excessively.

Then you request User State and get the successful response containing the new current step - "SELFIE_UPLOAD":

{
  "result": {
    "userInfo": {
"id": 21894,
      "status": "REGISTER",
      "step": "SELFIE_UPLOAD",
    }
  }
}

That means "RISK_SHORT" has been completed, and now Kavoon requires User’s “selfie” (self-portrait photograph) to be sent to Verify selfie liveness.

Thus,

  • each time Kavoon determines what the next step is, and Client reacts to it in a specific way. And so on until the last step

  • to figure out the current step Client checks out the param step in User State (at the start of registration) or in a response of a particular service.

4. Complete registration

Once the last step is completed, there is "status": "ACTIVE" in User State’s response, meaning that the account is created and the second-factor pin is set.

Is it necessary to go through all of the steps?

Yes. Without registration being completed Kavoon cannot provide full functionality such as initiating payments, providing a credit limit, balance etc.

Calling Kavoon services requires a second-factor pin which could be set only at the end of onboarding. Otherwise, the server refuses to authorise Client's request.

Reference table for Steps

Step

Onboarding section

Description

CONFIRM_RULES

Confirm Rules

Getting User’s consent with

  • Privacy Notice (what info is going to be collected and it’s intended usage)

  • Account Terms and Conditions (regarding User’s account and card issuance)

ENTRY_DATASET

Verify Individual Client

Collecting minimal information about User: name, address etc

RISK_SHORT

Financial Situation Questionnaire

Collecting quiz answers about User’s lifestyle (total monthly income, outgoings and expectations of financial situation)

CREDIT_OFFER

Soft Check

Getting User’s consent with

  • Soft Check Terms and Conditions (regarding using personal data for credit and identity checks)

WAIT

Waiting

Making User aware that the application is pending

INFO_SCREEN

Soft Check Decisions

Informing User that his application for opening account will be reviewed soon

CREDIT_SCREEN

Soft Check Decisions

Offering User a pre-calculated credit limit and interest based on an assessment of previously collected User’s data

BLOCK_CLIENT

Soft Check Decisions

Making User aware that there is a refusal to register (open account) him

CREDIT_DOCUMENTS

Signing Credit Agreement

Getting User’s consent (signature) with the terms of Credit Card agreement

CREDIT_INCREASE_PREFS

Credit Limit Increase

Asking User to select one of the options on how to increase his credit limit

CUSTOMER_OFFERS

Consent for Marketing

Getting User’s consent to receive offers from Kavoon by email

SELFIE_UPLOAD

Verify Selfie Liveness

Getting a selfie photo from User

DOCUMENT_UPLOAD

Verify Documents

Getting User’s identity document (Valid Passport or UK Driving License)

PreviousGet Financial dataNextPhone Number Verification

Last updated 2 years ago