Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

request_id

string

required

Unique identifier of the request, passed in the request.

Example

{
  "request_id": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://passport.freedompay.kz/api/v1/oauth/get-profile/status' \
--header 'Content-Type: application/json' \
--data-raw '{
  "request_id": "string"
}'

Responses

🟢200Success

application/json

Body

request_id

string

required

The unique request ID.

status

string

required

Status of the request:
pending: Request is being processed (data valid for 24 hrs).
completed: Request successfully completed (data valid for 60 min).
failed: An error occurred (data valid for 60 min).
not_found: The request ID lifetime has expired.

freedom_id

string <UUID>

required

Identifier of the user who granted permission.

profile

object

optional

Client profile data, if the request is successfully completed.

datetime

string <date-time>

required

The timestamp when the response was generated.

Example

{
  "request_id": "string",
  "status": "completed",
  "freedom_id": "UUID",
  "profile": {},
  "datetime": "2024-10-17T12:10:00Z"
}