GET
/
identity
/
identities
List Identities
curl --request GET \
  --url https://api.paxos.com/v2/identity/identities \
  --header 'Authorization: Bearer <token>'
{
  "next_page_cursor": "<string>",
  "items": [
    {
      "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
      "summary_status": "PENDING"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Query Parameters

​
summary_status
enum<string>

Summary Status of the Identity.

Available options:
PENDING,
ERROR,
APPROVED,
DENIED,
DISABLED
​
created_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
updated_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
limit
integer

Number of results to return.

​
order
enum<string>

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

Available options:
DESC,
ASC
​
order_by
enum<string>

The specific method by which the returned results will be ordered.

Available options:
CREATED_AT
​
page_cursor
string

Cursor token for fetching the next page.

​
identity_type
enum<string>

Optionally filter by Identity type

Available options:
PERSON,
INSTITUTION

Response

200 - application/json

A successful response.

The response is of type object.