Skip to main content
GET
List identity profiles

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

after
string | null

Returns the elements in the list that come after the specified cursor.

before
string | null

Returns the elements in the list that come before the specified cursor.

first
integer | null

Returns the first n elements from the list.

Example:

42

last
integer | null

Returns the last n elements from the list.

Example:

42

company_id
string | null

The unique identifier of the company to filter to. When omitted, returns IPs across all ledgers the actor can read.

Example:

"biz_xxxxxxxxxxxxxx"

profile_type
enum<string> | null

Filter by profile type (individual or business).

Available options:
individual,
business
status
enum<string> | null

Filter by derived verification status.

Available options:
not_started,
pending,
manual_review,
approved,
rejected,
action_required

Response

A successful response

The connection type for IdentityProfile.

data
object[]
required

A list of nodes.

page_info
object
required

Information to aid in pagination.