Skip to main content
POST
/
client
Initiate a new client
curl --request POST \
  --url https://client-api.dev.finhost.io/client \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John",
  "surname": "Doe",
  "nationality": "UKR",
  "birthday": "2017-07-21",
  "phone": "+380689873682"
}
'
{
  "transactionStatus": "Initiation completed"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Client name

Required string length: 1 - 15
Example:

"John"

surname
string
required

Client surname

Required string length: 1 - 30
Example:

"Doe"

nationality
string
required

Country ISO 3166-1 Alpha-3 code

Required string length: 3
Example:

"UKR"

birthday
string<date>
required

Client birthday in RFC 3339 (section 5.6)

Example:

"2017-07-21"

phone
string
required

Customer phone number

Example:

"+380689873682"

Response

The client was initiated

transactionStatus
string

Transaction Status

Example:

"Initiation completed"