Identity profiles

List identity profiles

Changed on

Lists the identity profiles currently linked to an account, or to every account you can read when account_id is omitted.

Required permissions:

  • identity:read
get/identity_profiles

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/identity_profiles
  • Auth: HTTP bearer

Query parameters

afterstring

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
profile_type'individual' | 'business'

The kind of identity profile (individual vs business).

status'not_started' | 'pending' | 'manual_review' | 'approved' | 'rejected' | 'action_required'

Derived verification status for an identity profile.

account_idstring

Account to list identity profiles for, prefixed biz_. Omit to list profiles across every account you can read, including child accounts under a parent and, with a user credential, your own user.

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "idpf_xxxxxxxxxxxxx",
      "linked_companies": [
        {
          "id": "biz_xxxxxxxxxxxxxx",
          "title": "Pickaxe"
        }
      ],
      "updated_at": "2023-12-01T05:00:00.401Z",
      "verifications": [
        {
          "created_at": "2023-12-01T05:00:00.401Z",
          "id": "verf_xxxxxxxxxxxxx",
          "last_error_reason": "Document image was too blurry to read.",
          "session_url": "https://verify.stripe.com/session/abc123"
        }
      ]
    }
  ]
}

Changes

  • 697924df40d1Revision changes
    • warning

      deleted the query request parameter company_id

    • info

      added the new optional query request parameter account_id

  • f67a043e3190Revision changes
    • breaking

      the query request parameter profile_type was restricted to a list of enum values

    • breaking

      the query request parameter status was restricted to a list of enum values

    • info

      added the new enum value action_required to the query request parameter status

    • info

      added the new enum value approved to the query request parameter status

    • info

      added the new enum value business to the query request parameter profile_type

    • info

      added the new enum value individual to the query request parameter profile_type

    • info

      added the new enum value manual_review to the query request parameter status

    • info

      added the new enum value not_started to the query request parameter status

    • info

      added the new enum value pending to the query request parameter status

    • info

      added the new enum value rejected to the query request parameter status

    • info

      for the query request parameter profile_type, the type was generalized from no type to string

    • info

      for the query request parameter status, the type was generalized from no type to string