Create client

POST

https://api.freedompay.kz/v5/card-api/client/add

This method is used to create a client in the Freedom Processing system. As a result, the client is assigned a unique identifier client_id, which is then used to link the client to issued payment cards.
After creation, the client_id can be used in other methods, such as updating client data or linking the client to a specific card.

Request

Body Params application/json

request_id

string

required

Unique request ID in the partner system (UUID).

product_id

integer

required

Identifier of the product within which the client is created.

branch_id

string

optional

Branch code. If not provided, the default branch is selected.

client

object

required

Client data.

phone

integer

required

Client's phone number.

type

integer

required

Client type:

1: Individual

2: Legal entity

3: Individual entrepreneur

resident

integer

required

Resident status of the client:

1: Resident

2: Non-resident

first_name

string

required

Client's first name (Latin).

last_name

string

required

Client's last name (Latin).

middle_name

string

optional

Client's middle name (Latin).

birthdate

string <date>

optional

Cardholder's birthdate (format: YYYY-MM-DD).

string

optional

Client's email address.

country

string

optional

Client's country of residence (alpha-3 code).

person_id

string

optional

Identifier of the client in the country of residence (e.g., Kazakhstan's IIN).

language

string

optional

Client's language of communication (alpha-2 code).

document

string

optional

Scan copy of the document verifying the client's identity (Base64 encoded, PDF format, max size 2MB).

external_user_id

string

optional

Identifier of the client in the partner system.

address1

object

optional

address2

object

optional

identification_info

object

optional

idn_date

string

required

Date of identification (format: RFC 3339, YYYY-MM-DDThh:mm:ss+hh:mm).

identified_by

string

required

Identifier of the user who conducted the client's identification.

Example

{
  "request_id": "string",
  "product_id": 0,
  "branch_id": "string",
  "client": {
    "phone": 0,
    "type": 0,
    "resident": 0,
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "birthdate": "2019-08-24",
    "email": "string",
    "country": "string",
    "person_id": "string",
    "language": "string",
    "document": "string",
    "external_user_id": "string",
    "address1": {
      "country": "string",
      "postal_code": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string"
    },
    "address2": {
      "country": "string",
      "postal_code": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string"
    }
  },
  "identification_info": {
    "idn_date": "string",
    "identified_by": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/card-api/client/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "product_id": 0,
    "branch_id": "string",
    "client": {
        "phone": 0,
        "type": 0,
        "resident": 0,
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "birthdate": "2019-08-24",
        "email": "string",
        "country": "string",
        "person_id": "string",
        "language": "string",
        "document": "string",
        "external_user_id": "string",
        "address1": {
            "country": "string",
            "postal_code": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string"
        },
        "address2": {
            "country": "string",
            "postal_code": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_line3": "string"
        }
    },
    "identification_info": {
        "idn_date": "string",
        "identified_by": "string"
    }
}'

Responses

🟢200Success

application/json

Body

status

string

required

Status of the request. Possible values:

ok: Request completed successfully.

error: Request completed with an error.

request_status

string

required

Execution status of the request. Refer to the documentation.

string <date-time>

required

Date and time of the request (format: RFC 3339, YYYY-MM-DDThh:mm:ss+hh:mm).

Example

{
  "status": "string",
  "request_status": "string",
  "dt": "2019-08-24T14:15:22Z"
}

Statement extended

Edit client