Freedom Pay
  1. Freedom ID
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
        • Edit
        • Card list
      • 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
        POST
      • Token
        POST
      • Token refresh
        PATCH
      • Info
        GET
      • Profile
        POST
      • Request
        GET
  • 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. Freedom ID

Introduction

 Freedom ID is a unified account system for accessing services provided by the Freedom Group of Companies and supported third-party websites or applications.
 This API enables configuring a single sign-on experience for your website or mobile application.
The Freedom ID API offers the following benefits:
Unified Authorization:
Users can log into your website or application using their existing Freedom ID account, removing the need for new account registrations and forms.
Data Transfer:
With user consent, necessary data can be retrieved for account creation or updates.
Web Authorization:
Allows login via Freedom ID widgets or buttons on your site.
Mobile Authorization:
Integrates SDKs for mobile devices to facilitate seamless login if users are already signed into Freedom ID on their devices.

How It Works#

Authorization Process
Once integrated, your service’s login page will display an option to log in via Freedom ID.
Users selecting this option are redirected to the Freedom ID authorization page to approve login and data sharing.
Token Exchange
Upon successful authorization, your service receives an authorization_code via the specified redirect_uri.
This code must be exchanged for access_token and refresh_token using a token request.
Retrieving User Data
Using the client_access_token, send a request to the Freedom ID API to obtain user data.
This data can then be used to authenticate and register the user in your system without requiring a new account.
Client Profile Request
To retrieve additional user profile information, submit a "Client Profile" request.
Prior user consent is required for profile access.

API Integration Steps#

Freedom_ID_API_5.jpg

Partner Service Registration with Freedom ID#

 To work with the Freedom ID API, a partner service needs credentials (Login and Password). These can be obtained by contacting the product support team via email: support@freedompay.uz.
Your email should include:
Service Name
Platforms (e.g., web, iOS, Android)
Contact Information of responsible personnel

Example Email#

Subject: Request for Service Integration with Freedom ID API  

Dear Freedom ID Support Team,  

My name is [Your Name], representing the platform [Your Company Name]. We aim to integrate our service with the Freedom ID API for unified user authorization.  

Service Name: [Your Service Name]  
Platforms: [Platform List]  
Contact Details:  
- Name: [Responsible Person's Name]  
- Position: [Position]  
- Email: [Email Address]  
- Phone: [Phone Number] 

User Data Access Codes#

ParameterDescription
date_of_birthUser's date of birth (e.g., read.date_of_birth).
firstnameUser's first name (e.g., read.firstname).
lastnameUser's last name (e.g., read.lastname).
patronymicUser's patronymic (e.g., read.patronymic).
countryUser's citizenship (e.g., read.country).
nationalityUser's nationality (e.g., read.nationality).
genderUser's gender (e.g., read.gender).
identifierUser's identifier (e.g., read.identifier).
phoneUser's primary phone number (e.g., read.phone).
emailUser's primary email address (e.g., read.email).
phonesAdditional phone numbers (e.g., read.phones).
emailsAdditional email addresses (e.g., read.emails).
profileExtended profile data (e.g., read.profile).

User Data Parameters#

ParameterTypeDescription
date_of_birthstring (YYYY-MM-DD)User's date of birth.
firstnamestringUser's first name.
lastnamestringUser's last name.
patronymicnull or stringUser's patronymic.
countrystringUser's country.
nationalitystringUser's nationality.
genderstringUser's gender.
identifierstringUser's identifier.
phonestringUser's primary phone number.
emailstringUser's primary email address.
phonesarray of stringsAdditional phone numbers.
emailsarray of stringsAdditional email addresses.

Link#

 This method generates a link to redirect users to the Freedom ID authentication page. The service sends a request specifying:
The URL where the user will be redirected after successful authentication (redirect_uri).
An array of data types required by the service from the user (grants).
 In response, the service receives a generated link to redirect the user for authentication.

Token#

 When a user consents to provide the requested access rights, Freedom ID redirects the user to the specified redirect_uri with an appended authorization_code parameter. This one-time code must be exchanged for an access_token and refresh_token for subsequent operations.

Token refresh#

 This method is used to refresh an expired access_token using a refresh_token. If the access_token has expired, the application can use the refresh_token to request a new set of tokens.

Info#

 This method allows an application to obtain user information using a valid access_token. The response includes data that can be used for the application's user interface or other purposes.

Profile#

 This method retrieves personal and other analytical data about the client (user). Before making this request, the application must request the read.profile grant during the authentication link generation step. If the user consents and the grant is active, the profile data request is queued for processing.

Request#

 This method retrieves the status of a client profile request.
Previous
Request Status
Next
Android SDK