Freedom Pay
  1. Client
Freedom Pay
  • Gateway API
    • Introduction
    • Reference
      • Test cards
      • Error codes
    • Sync API
      • Introduction
      • Page
        • Introduction
        • Page
        • Page with amount control
        • Status
      • Pay
        • Introduction
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Introduction
        • Card
        • IBAN
        • Balance
        • Status
        • StatusV2
      • Transfer
        • Introduction
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Introduction
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Introduction
        • Token Pay
        • Apple Pay
        • Google Pay
        • Samsung Pay
        • Token Payout
        • Status
    • Async API
      • Introduction
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Introduction
    • Reference
      • Test cards
      • Test phone numbers
      • Error codes
    • Page
      • Introduction
      • Page
      • Page with amount control
      • Payout page
      • Frame
      • Widget
      • Status
    • Pay
      • Introduction
      • Cancel
      • Clearing
      • Refund
      • Status
    • Payout
      • Introduction
      • IBAN
      • Balance
      • Status by order_id
      • Status by Payment ID
      • Status by Payment ID V2
    • Mobile balance
      • Introduction
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Card
      • Introduction
      • Add
      • Add for payout
      • Remove
      • List
      • Status
    • Token
      • Introduction
      • Saved card with CVC input (Init)
      • Saved card with CVC input (Pay)
      • Non-acceptance payments
      • Non-acceptance payments (Pay)
      • Token payout
      • Status
    • Invoice
      • Introduction
      • Init
      • Info
      • Pay
      • Status
    • Additional
      • Introduction
      • Check request
      • Result notify
      • Payout notify
      • Redirect back
  • Card API
    • Introduction
    • Payment Cards
      • Reference
        • Request Status
        • Client product
        • Card product
        • Card status
        • Card block
        • Transaction
        • Error codes
      • Card issue
        • Bulk
        • Single
        • Physical
      • Card control
        • Activate
        • Block
        • Unblock
        • Set PIN
        • Reset PIN counter
        • Close
        • Identification
        • Info
        • Balance
        • Secret data
        • Statement
      • Client
        • Create
          POST
        • Edit
          POST
        • Card list
          POST
      • Additional
        • Request status
    • Gift Cards
      • Introduction
      • Reference
        • Request status
        • Card status
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Introduction
      • Rates
    • Products
      • Introduction
      • Reference
        • Request
        • Product
        • Freedom POS
        • Freedom ECOM
        • Freedom BOX
        • Limits
      • Add user
      • Add product
      • Add user with product
      • Grant user
      • Send auth data
      • Request status
    • E-Money
      • Introduction
      • Reference
        • Request
        • Operation
        • Error codes
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Introduction
      • Android SDK
      • iOS SDK
      • Reference
        • Error codes
      • Link
      • Token
      • Token refresh
      • Info
      • Profile
      • Request
  • Mobile SDK
    • Payment SDK
      • iOS
      • Android
    • Freedom QR
      • Reader SDK (Android)
      • Provider SDK (Android)
  • CMS
    • Introduction
    • Get Merchant ID and key
    • WordPress
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
      • Update
    • Tilda
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • InSales
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Ecwid
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Bitrix
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • PrestaShop
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • OpenCart
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
  1. Client

Create

POST
https://api.freedompay.uz/v5/card-api/client/add

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 
optional
Client type:
1: Individual
2: Legal entity
3: Individual entrepreneur
resident
integer 
optional
Resident status of the client:
1: Resident
2: Non-resident
first_name
string 
optional
Client's first name (Latin).
last_name
string 
optional
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).
email
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 
optional
Date of identification (format: RFC 3339, YYYY-MM-DDThh:mm:ss+hh:mm).
identified_by
string 
optional
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.freedompay.uz/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.
dt
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"
}
Previous
Statement
Next
Edit