Create user

POST

https://api.freedompay.kz/api/v1/oauth/user

With certain access rights, the partner can add a user independently. The phone number must be unique, there cannot be two users with the same phone in the system. E-mail is also a unique attribute, but if there are conflicts, an error will not occur when creating a user, such an e-mail address will be skipped when saving.
The response will return a new FreedomID.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

phone

string

required

Phone number

Example:

+1234567890

Match pattern:

^\+\d{10,15}$

string <email>

optional

Email (must be unique)

firstname

string

optional

Firstname

Examples:

JohnJane

lastname

string

optional

Lastname

Example:

Doe

date_of_birth

string <Y-m-d>

optional

Date of birth

Example:

2000-01-01

identifier

string

optional

Person identifier

Example:

123456789

country

string

optional

Country ISO 3166-1 alpha-3

>= 3 characters<= 3 characters

Examples:

KAZRUS

Match pattern:

^[A-Z]{3}$

gender

string

optional

Gender

>= 1 characters<= 1 characters

Examples:

Match pattern:

^(M|F)$

nationality

string

optional

Nationality

Example:

citizen of the world

Example

{
  "phone": "+1234567890",
  "email": "user@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "date_of_birth": "2000-01-01",
  "identifier": "123456789",
  "country": "KAZ",
  "gender": "M",
  "nationality": "citizen of the world"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/api/v1/oauth/user' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone": "+1234567890",
    "email": "user@example.com",
    "firstname": "John",
    "lastname": "Doe",
    "date_of_birth": "2000-01-01",
    "identifier": "123456789",
    "country": "KAZ",
    "gender": "M",
    "nationality": "citizen of the world"
}'

Responses

🟢200Success

application/json

Body

freedom_id

string <uuid>

required

Freedom ID (UUID)

Example

{
  "freedom_id": "eeca9287-d824-4f50-928b-450d2e46f874"
}

Get profile status

Update user