Get profile status - Freedom Pay

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 <uuid>

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 <uuid>

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.

status_message

string

optional

Description of the status.

freedom_id

string <uuid>

optional

Identifier of the user who granted permission.

profile

object

optional

Client profile data, if the request is successfully completed.

datetime

string <Datetime:ISO-8601>

optional

The timestamp when the response was generated.

Example

{
    "request_id": "UUID",
    "status": "accepted",
    "status_message": "PROCESS: profile is pending",
    "freedom_id": "UUID",
    "profile": {
        "payload": "DTFcQKJik68Lq0wNavBlW0IDNrWK4TNd185zMX6Q15HimlQcOLfZFFBNN9ECR456isIQYbrRJTsoePhcIs23YlmFeomgwAXr"
    },
    "datetime": "2025-02-25T06:50:46.555757Z"
}