Verify Individual Client

Quick reference

1. Structure of entry info about User

2. Choosing nationality

3. Current address

4. Previous address

The purpose of this step is to collect minimal information about User such as a name, birth date, address etc. It’s triggered by step: ENTRY_DATASET

Entry info about User

At this point, Client shall obtain the following User’s details

• First name

• Last name

• Birth date

• Email

• Nationality

• Current address (contains sub-items)

• Previous address (contains sub-items)

Please refer to the API details in the end of the article to look up specific constraints to each component

Choosing nationality

User can select a nationality from the proposed list only. Such list can be retrieved by calling the API below.

Get nationalities

GET https://api.kavoon.io/api/client-info/dictionary/countries

This method outputs a list of nationalities basing on a postal code.

The request body must be empty.

200: OK

{
"result":
 [
  {"name" : "Austrian", "code":"AUS", "flag":"🇦🇹" },
  {"name" : "Afghanistan", "code":"AFG", "flag":"🇦🇫"},
  {"name" : "Åland Islands", "code":"ALA", "flag":"🇦🇽"}
 ]
}

Current address

The full list of address components is described in API details below.

So that User doesn't fill out all of the fields manually, Client might pre-fill them automatically. For this purpose, he should

• ask User for a postal code

• send it to API details below

• retrieve the list of result addresses

• ask User to select one

• pre-fill the fields with the respective components of the selected address

However, there is always a chance of no results found. In this case, User has to enter the data manually.

Previous address

Provided User has specified that he lived at the current address for less than six months, he shall submit his previous address. The required components are described in the API details below.

As in the previous case, Client might pre-fill the fields with components

Submit user entry data

POST https://api.kavoon.io/api/user-info/save-first-info

Request Body

Name	Type	Description
lastName*	String	Min 2, max 15 chars. Allowed symbols: - / , _ – — " ” ` ‘ ’ ' ‘
previousAdsress	String	Object Like currentAddress, it includes params from flat to organisation
organisation	String	1st level organisation
countryCode	String	Country code. If null then GBR by default.
country	String	If null then United Kingdom by default
postalCode*	String	E.g. “SW4 6EH”. Max 7 chars; min 1 char. Chars / . ’ _ • not allowed
town*	String	Max 20 chars; min 1 char. Chars / . ’ _ • not allowed.
street*	String	Max 40 chars; min 1 char. Chars / . ’ _ • not allowed
subOrganisation	String	2nd level housing unit
building*	String	Building number. Mutually exclusive with housing or may be both. Max 10 chars; min 1 char. Chars / . ’ _ • not allowed
housing*	String	1st level housing unit. Mutually exclusive with building or may be both. Max 20 chars; min 1 char. Chars / . ’ _ • not allowed
flat	String	Max 20 chars; min 1 char. Chars / . ’ _ • not allowed
currentAddress*	String	Object It includes params from flat to organisation
nationality*	String	Regular name of the country e.g. “United Kingdom”, “Congo”, “Vietnam”
email*	String	Standard format rules (that is recipient name, @ symbol, domain nameTop-level, domain etc)
birthDate*	String	Format: “YYYY-MM-DD”. Min: 01-01-1900. Max: current date minus 18 years (age restrictions)
firstName*	String	Min 2, max 15 chars. Allowed symbols: - / , _ – — " ” ` ‘ ’ ' ‘

200: OK

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

Request body

{
 "openBank": "true"
 "lastName":"Stevenson",
 "firstName":"Robert",
 "birthDate":"1950-11-13",
 "email":"[e-mail]",
 "nationality":"",
 "currentAddress": {
   "flat":"68",
   "housing":"Shipstones Business Centre",
   "building":"10",
   "subOrganisation":"Giles Cooper Awards",
   "street":"Richmond Rd",
   "organisation":"British Broadcasting Corporation",
   "town":"Bristol",
   "postalCode":"SW4 6EH",
   "country":"UK",
   "countryCode":"GBR"
 },
 "previousAddress": {
   "flat":"68", 
   "housing":"Shipstones Business Centre",
   "building":"10",
   "subOrganisation":"Giles Cooper Awards",
   "street":"Richmond Rd",
   "organisation":"British Broadcasting Corporation",
   "town":"Bristol",
   "postalCode":"SW4 6EH",
   "country":"UK",
   "countryCode":"GBR"
  }
}