Phone Number Verification

The goal of this process is to verify User’s mobile number. If successful, Client acquires a first authentication factor allowing him to access onboarding APIs (including Get User State).

Note: User must have the UK number

The verification shall start before onboarding and consists of two stages:

1. Request sending a one time password (OTP) via SMS to User's phone

The request must include the full phone number and channel: sms

Request OTP

POST https://api.kavoon.io/otp

Request Body

Name	Type	Description
phone*		Full mobile number e.g. "447401101801"
channel*	String	Sending channel. Use "sms"

200: OK

{ }

400: Bad Request

{
  "errCode": "GENERAL_ERROR",
  "errText": "invalid Device-Id"
}

2. Verify OTP and receive authentication token

Verify OTP

POST https://api.kavoon.io/auth/token

In case of successful verification, Client gets an access_token

Request Body

Name	Type	Description
grant_type*	String	Request type. Pass "password"
username*	String	Full mobile number e.g. "447401101801"
password*	String	Received OTP e.g. "5757"
channel*	String	Sending channel. Use "sms"

200: OK

{
  "access_token": "f7bf9bcb493d45cb99164ba7653b2e0a",
  "token_type": "Bearer",
  "expires_in": 300,
  "refresh_token": "7b7b75b866814bd3bf14409b796894f0",
  "new_client": true
}

400: Bad Request

{
  "errCode": "BAD_REQUEST",
  "errText":"Check OTP exception"
}

If success, Client will retrieve the first authentication factor and will be able to call the User State to start onboarding to find out what is the first step. If the password does not match, Client will receive the respective error.