Freedom Pay

Authorization link

POST

https://passport.freedompay.kz/api/v1/oauth/authorize

oauth2

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.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/json

redirect_uri

string

required

The URL to which the user will be redirected after authentication with authorization_code.

grants

array[string]

required

Array of access permissions requested from the user. The array must be formatted as 'access level'.'access code'. A list of access codes is available in the reference guide. (example: read.phone)

Example

{
  "redirect_uri": "https://example.com/login",
  "grants": [
    "read.email",
    "read.emails",
    "read.phone",
    "read.phones",
    "read.date_of_birth",
    "read.firstname",
    "read.lastname",
    "read.patronymic",
    "read.gender",
    "read.country",
    "read.nationality",
    "read.identifier",
    "read.profile",
    "read.cards",
    "openid"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://passport.freedompay.kz/api/v1/oauth/authorize' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "redirect_uri": "https://example.com/login",
  "grants": [
    "read.email",
    "read.emails",
    "read.phone",
    "read.phones",
    "read.date_of_birth",
    "read.firstname",
    "read.lastname",
    "read.patronymic",
    "read.gender",
    "read.country",
    "read.nationality",
    "read.identifier",
    "read.profile",
    "read.cards",
    "openid"
  ]
}'

Responses

🟢200Success

application/json

Body

redirect_uri

string <URL>

required

Link to redirect the user to pass authentication on the FreedomID side.

Example

{
  "redirect_uri": "https://passport.freedompay.kz/login?track_id=ac22c50c-22c7-4aeb-9160-e59b735f9c44&expire_at=1727246098"
}

Android SDK

Token exchange