Freedom Pay
  1. OAuth2
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • 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
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • 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
      • 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
    • 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
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Dictionaries
      • Bulk issue
      • Issue card
      • Issue plastic card
      • Activate card
      • Block card
      • Unblock card
      • Set PIN
      • Reset PIN counter
      • Close card
      • Update client
      • Card info
      • Balance
      • Secret data
      • Secret data (version 2)
      • Statement
      • Statement extended
      • Create client
      • Edit client
      • Сards' list
      • Request' status
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction request' status
      • Transaction info
    • Gift Cards
      • Overview
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Overview
      • Design
      • iOS SDK
      • Android SDK
      • OAuth2
        • Authorization link
          POST
        • Token exchange
          POST
        • Token refresh
          PATCH
        • User info
          GET
        • Request profile
          POST
        • Get profile status
          GET
        • Create user
          POST
        • Update user
          PUT
      • OIDC
        • Authorization endpoint
        • Token exchange
        • Userinfo
      • Error codes
      • Examples
        • Keycloak
    • Transfer
      • Overview
      • Get token
      • Refresh token
      • Get agents
      • Fees
      • Create person
      • Create business
      • Create transfer
      • Print application
      • Confirm
      • Search
      • Payout
      • Payout confirm
      • Cancel
      • Get person info
      • Get business info
      • Status
      • Info
    • Device ID
      • Android SDK
      • iOS SDK
  1. OAuth2

Update user

PUT
https://api.freedompay.kz/api/v1/oauth/user
The data change occurs according to the existing FreedomID.
When updating user data, it is necessary to take into account that in this case the phone number and email address must be unique values ​​in the system.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
freedom_id
string <uuid>
required
Freedom ID (UUID)
phone
string 
optional
Phone number
Example:
+1234567890
Match pattern:
^\+\d{10,15}$
email
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:
MF
Match pattern:
^(M|F)$
nationality
string 
optional
Nationality
Example:
citizen of the world
Example
{
  "freedom_id": "eeca9287-d824-4f50-928b-450d2e46f874",
  "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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.freedompay.kz/api/v1/oauth/user' \
--header 'Content-Type: application/json' \
--data-raw '{
    "freedom_id": "eeca9287-d824-4f50-928b-450d2e46f874",
    "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"
}
Previous
Create user
Next
Authorization endpoint