Skip to main content
GET
/
v2
/
identity
/
controls
List Identity Controls
curl --request GET \
  --url https://api.example.com/v2/identity/controls \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "type": "SELL_ONLY",
      "set_by": "SET_BY_PAXOS",
      "is_overridable": true,
      "reason_code": "OTHER",
      "reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_cursor": "<string>"
}
OAuth Scope
identity:read_identity_control

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
identity_id
string
required

The Identity ID whose controls to retrieve.

​
include_deleted
boolean

Include deleted controls in the response.

​
limit
integer<int32>

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

​
page_cursor
string

Optional: Cursor for getting the next page of results.

Response

A successful response.

​
items
object[]

The list of identity controls.

​
next_page_cursor
string

Cursor token for fetching the next page. Empty if there are no more pages.