Freedom Pay
  1. Client
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • Recurrent
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Overview
        • Card
        • IBAN
        • Balance
        • Status
      • Transfer
        • Overview
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Overview
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Overview
        • Token Pay
        • Apple Pay
        • Google Pay
        • Token Payout
        • Status
    • Async API
      • Overview
      • create
        • create payment
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
  • Merchant API
    • Overview
    • Purchase
      • Overview
      • Checkout
      • Card token
        • Overview
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment (with CVC)
        • Confirm payment (with CVC)
        • Create payment
        • Confirm payment
      • Create payment
      • Any amount
      • Reccuring payment
      • Cancel payment
      • Clearing
      • Refund payment
      • Status
    • Payout
      • Overview
      • Card token
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment
      • Create payment
      • IBAN
      • Balance status
      • Status by order_id
      • Status by Payment ID
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Init
      • Info
      • Pay
      • Status
    • SDK
      • JS SDK
      • Google Pay
      • Freedom QR
        • Reader SDK (Android)
        • Provider SDK (Android)
      • Payment SDK
        • iOS
        • Android
      • Merchant SDK
        • Android
    • CMS
      • Overview
      • Get Merchant ID and key
      • WordPress
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
        • Update
      • Tilda
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • InSales
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Ecwid
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Bitrix
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • PrestaShop
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • OpenCart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Redirect back
    • Result notify
    • Payout notify
    • Check request
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Client
        • Create client
          POST
        • Create client
          POST
        • Edit client
          POST
        • Update client
          POST
        • Verify client
          POST
      • Transactions
        • Create transaction
        • Clearing transaction
        • Refund transaction
        • Transaction info
        • Transaction status
      • Activate card
        POST
      • Balance
        POST
      • Block card
        POST
      • Bulk issue
        POST
      • Card info
        POST
      • Сards' list
        POST
      • Card tokenization
        POST
      • Cardholder validation
        POST
      • Close card
        POST
      • Issue card
        POST
      • Issue plastic card
        POST
      • Limits list
        POST
      • Operations' list
        POST
      • Reset PIN counter
        POST
      • Request' status
        POST
      • Secret data
        POST
      • Set limits
        POST
      • Set PIN
        POST
      • Statement extended
        POST
      • Unblock card
        POST
    • Gift Cards
      • Overview
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Request status
      • Create terminal
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
    • Account
      • Settlement
        • Overview
        • Create payment
        • Payment status
        • Batch statuses
    • Invoice
  1. Client

Create client

Developing
POST
https://api.freedompay.kz/v5/card-api/client/add_v2
This method is used to create a client in the Freedom Processing system.
Version v2 extends the base functionality of client creation by introducing additional identification fields, enhanced residency formats, device metadata, and support for asynchronous status handling through callback notifications.
Upon successful execution, the system creates a new client profile and assigns a unique client_id. This identifier is used in further operations such as issuing cards, updating client information, and linking the client to a specific card

Request

Header Params

Body Params application/json

Example
{
    "additional": [
        {
            "key": "device_os_type",
            "value": "string"
        }
    ],
    "product_id": 1000,
    "request_id": "ff5e8077ebde09eddd14f8e1784b9885727d7fb3ba0e784e94a64fd3790eaf4f",
    "branch_id": "string",
    "client": {
        "device_id": "string",
        "type": "1",
        "citizenship": "KAZ",
        "fn_id": "string",
        "ln_id": "string",
        "external_user_id": "string",
        "idn": "string"
    },
    "callback_uri": "string"
}

Responses

🟢200Success
application/json
Body

Example
{
    "status": "ok",
    "request_status": "success",
    "dt": "2025-01-01T00:01:01+00:30"
}
Previous
Create client
Next
Edit client