Skip to main content
GET
/
identity_profiles
List identity profiles
curl --request GET \
  --url https://api.whop.com/api/v1/identity_profiles \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "idpf_xxxxxxxxxxxxx",
      "profile_type": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "personal_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "business_name": "<string>",
      "business_structure": "<string>",
      "business_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "country": "<string>",
      "linked_companies": [
        {
          "id": "biz_xxxxxxxxxxxxxx",
          "title": "Pickaxe"
        }
      ],
      "verifications": [
        {
          "id": "verf_xxxxxxxxxxxxx",
          "session_url": "https://verify.stripe.com/session/abc123",
          "last_error_reason": "Document image was too blurry to read.",
          "created_at": "2023-12-01T05:00:00.401Z"
        }
      ],
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

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,
approved,
rejected

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.