Owner identification - Freedom Pay

Request

Body Params application/json

request_id

string <uuid>

required

Unique request number in the partner's system (UUID).

identifier

string

required

Unique wallet identifier from the partner.

owner

object

required

Wallet owner's data.

first_name

string

required

Wallet owner's first name.

last_name

string

required

Wallet owner's last name.

middle_name

string

optional

Wallet owner's middle name.

birthdate

string <date>

optional

Wallet owner's date of birth (Format: YYYY-MM-DD).

phone

integer

required

Wallet owner's phone number.

email

string

optional

Wallet owner's email address.

country

string

required

Wallet owner's country of residency (alpha-3 format).

person_id

string

required

Wallet owner's identifier in the country of residency (e.g., Tax ID for Kazakhstan, Personal ID for Russia).

language

string

optional

Wallet owner's communication language (alpha-2 format).

document

string

required

Scanned copy of the wallet owner's identity document:

File format: PDF

Base64 encoding

Max size: 2 MB.

address1

object

required

Registration address data object.

address2

object

required

Residential address data object.

identification_info

object

required

Wallet owner's identification data object.

Example

{
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  "identifier": "string",
  "owner": {
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "birthdate": "2019-08-24",
    "phone": 0,
    "email": "string",
    "country": "string",
    "person_id": "string",
    "language": "string",
    "document": "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": "2019-08-24T14:15:22Z",
      "identified_by": "string"
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kz/v5/partner/wallet/identify' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

status

string

required

Indicates the request status:

ok: Request completed successfully.

error: Request failed with an error.

request_status

string

required

Status of request execution. Refer to the status guide.

dt

string <date-time>

required

Date and time of the request in RFC 3339 format.
Format: YYYY-MM-DDThh:mm:ss+hh:mm.

error_code

string

optional

Error code ID. Returned only in case of errors.

error_description

string

optional

Text description of the error. Returned only in case of errors.

Example

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