Request profile - Freedom Pay

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.

Possible statuses:

accepted

rejected

pending

completed

not_found

forbidden

error

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 request identifier generated by the partner.

Example

{
  "request_id": "UUID",
  "created_at": "2024-10-17T12:00:00Z"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

request_id

string <uuid>

required

The unique request ID sent in the request.

status

string

required

Status of the request.
accepted: New request is being processed.
rejected: Request was denied (e.g., permission error).
pending: Request is in progress.

status_message

string

optional

Description of the status.

freedom_id

string <uuid>

optional

The client identifier in the Freedom ID system.

Example

{
  "request_id": "UUID",
  "status": "accepted",
  "status_message": "PROCESS: profile is pending",
  "freedom_id": "UUID"
}