> ## 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.

# List identity profiles

> Returns a paginated list of identity profiles. When company_id is provided, lists IPs currently linked to that company's ledger. When omitted, lists IPs linked to any ledger the actor can read (including child companies under a parent).

Required permissions:
 - `identity:read`



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /identity_profiles
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    The Whop REST API. Please see
    https://docs.whop.com/developer/api/getting-started for more details.
  termsOfService: https://whop.com/tos-developer-api/
  version: 1.0.0
  x-api-version-date: '2026-06-09'
servers:
  - url: https://api.whop.com/api/v1
    description: Production Whop API
  - url: https://sandbox-api.whop.com/api/v1
    description: Sandbox Whop API
security: []
tags:
  - name: Products
    description: Products
  - name: Payments
    description: Payments
  - name: Refunds
    description: Refunds
  - name: Disputes
    description: Disputes
  - name: Dispute alerts
    description: Dispute alerts
  - name: Resolution center cases
    description: Resolution center cases
  - name: Checkout configurations
    description: Checkout configurations
  - name: Setup intents
    description: Setup intents
  - name: Payment methods
    description: Payment methods
  - name: Invoices
    description: Invoices
  - name: Promo codes
    description: Promo codes
  - name: Card transactions
    description: Card transactions
  - name: Ledger accounts
    description: Ledger accounts
  - name: Transfers
    description: Transfers
  - name: Withdrawals
    description: Withdrawals
  - name: Payout methods
    description: Payout methods
  - name: Verifications
    description: Verifications
  - name: Identity profiles
    description: Identity profiles
  - name: Payout accounts
    description: Payout accounts
  - name: Topups
    description: Topups
  - name: Companies
    description: Companies
  - name: Authorized users
    description: Authorized users
  - name: Fee markups
    description: Fee markups
  - name: Members
    description: Members
  - name: Memberships
    description: Memberships
  - name: Leads
    description: Leads
  - name: Entries
    description: Entries
  - name: Shipments
    description: Shipments
  - name: Reviews
    description: Reviews
  - name: Company token transactions
    description: Company token transactions
  - name: Affiliates
    description: Affiliates
  - name: Experiences
    description: Experiences
  - name: Forums
    description: Forums
  - name: Forum posts
    description: Forum posts
  - name: Chat channels
    description: Chat channels
  - name: Support channels
    description: Support channels
  - name: Messages
    description: Messages
  - name: Reactions
    description: Reactions
  - name: Dm members
    description: Dm members
  - name: Dm channels
    description: Dm channels
  - name: Notifications
    description: Notifications
  - name: Courses
    description: Courses
  - name: Course chapters
    description: Course chapters
  - name: Course lessons
    description: Course lessons
  - name: Course students
    description: Course students
  - name: Course lesson interactions
    description: Course lesson interactions
  - name: Apps
    description: Apps
  - name: Webhooks
    description: Webhooks
  - name: App builds
    description: App builds
  - name: Access tokens
    description: Access tokens
  - name: Account links
    description: Account links
  - name: Files
    description: Files
  - name: Ai chats
    description: Ai chats
  - name: Bounties
    description: Bounties
  - name: Stats
    description: Stats
  - name: Ad campaigns
    description: Ad campaigns
  - name: Ad groups
    description: Ad groups
  - name: Ads
    description: Ads
  - name: Conversions
    description: Conversions
  - name: Ad reports
    description: Ad reports
paths:
  /identity_profiles:
    get:
      tags:
        - Identity profiles
      summary: List identity profiles
      description: >-
        Returns a paginated list of identity profiles. When company_id is
        provided, lists IPs currently linked to that company's ledger. When
        omitted, lists IPs linked to any ledger the actor can read (including
        child companies under a parent).


        Required permissions:
         - `identity:read`
      operationId: listIdentityProfile
      parameters:
        - name: after
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
            description: >-
              Returns the elements in the list that come after the specified
              cursor.
          explode: true
          style: form
        - name: before
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
            description: >-
              Returns the elements in the list that come before the specified
              cursor.
          explode: true
          style: form
        - name: first
          in: query
          required: false
          schema:
            type:
              - integer
              - 'null'
            description: Returns the first _n_ elements from the list.
            example: 42
          explode: true
          style: form
        - name: last
          in: query
          required: false
          schema:
            type:
              - integer
              - 'null'
            description: Returns the last _n_ elements from the list.
            example: 42
          explode: true
          style: form
        - name: company_id
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
            description: >-
              The unique identifier of the company to filter to. When omitted,
              returns IPs across all ledgers the actor can read.
            example: biz_xxxxxxxxxxxxxx
          explode: true
          style: form
        - name: profile_type
          in: query
          required: false
          schema:
            oneOf:
              - $ref: '#/components/schemas/IdentityProfileKinds'
              - type: 'null'
            description: Filter by profile type (individual or business).
          explode: true
          style: form
        - name: status
          in: query
          required: false
          schema:
            oneOf:
              - $ref: '#/components/schemas/IdentityProfileStatuses'
              - type: 'null'
            description: Filter by derived verification status.
          explode: true
          style: form
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityProfileListItem'
                    description: A list of nodes.
                  page_info:
                    $ref: '#/components/schemas/PageInfo'
                    description: Information to aid in pagination.
                required:
                  - data
                  - page_info
                description: The connection type for IdentityProfile.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: invalid_request_error
                  code: parameter_missing
                  message: 'Missing required parameter: amount.'
                  param: amount
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: unauthorized
                  message: Invalid or missing API key
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: forbidden
                  message: You do not have permission to access this resource
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: not_found
                  message: Resource not found
        '422':
          description: Verification required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error: null
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: internal_server_error
                  message: An unexpected error occurred
      security:
        - bearerAuth:
            - identity:read
components:
  schemas:
    IdentityProfileKinds:
      type: string
      enum:
        - individual
        - business
      description: The kind of identity profile (individual vs business).
    IdentityProfileStatuses:
      type: string
      enum:
        - not_started
        - pending
        - approved
        - rejected
      description: Derived verification status for an identity profile.
    IdentityProfileListItem:
      type: object
      properties:
        id:
          type: string
          description: The tag of the identity profile (idpf_xxx).
          example: idpf_xxxxxxxxxxxxx
        profile_type:
          type: string
          description: Whether this is an 'individual' or 'business' profile.
        status:
          $ref: '#/components/schemas/IdentityProfileStatuses'
          description: Derived verification status across all linked verifications.
        first_name:
          type:
            - string
            - 'null'
          description: Individual's first name.
        last_name:
          type:
            - string
            - 'null'
          description: Individual's last name.
        date_of_birth:
          type:
            - string
            - 'null'
          description: >-
            ISO date (`YYYY-MM-DD`) reported by the identity provider. Present
            on `individual` profiles.
        email:
          type:
            - string
            - 'null'
          description: >-
            Email address reported by the identity provider. Typically present
            on `individual` profiles.
        phone:
          type:
            - string
            - 'null'
          description: >-
            Phone number reported by the identity provider. Typically present on
            `individual` profiles.
        personal_address:
          type:
            - object
            - 'null'
          properties:
            line1:
              type:
                - string
                - 'null'
              description: The line 1 of the address.
            line2:
              type:
                - string
                - 'null'
              description: The line 2 of the address.
            city:
              type:
                - string
                - 'null'
              description: The city of the address.
            state:
              type:
                - string
                - 'null'
              description: The state of the address.
            postal_code:
              type:
                - string
                - 'null'
              description: The postal code of the address.
            country:
              type:
                - string
                - 'null'
              description: The country of the address.
          required:
            - line1
            - line2
            - city
            - state
            - postal_code
            - country
          description: >-
            Residential address reported by the identity provider. Present on
            `individual` profiles.
        business_name:
          type:
            - string
            - 'null'
          description: Business entity name. Present on `business` profiles.
        business_structure:
          type:
            - string
            - 'null'
          description: >-
            Reported legal structure of a business profile (e.g. `corp`, `llc`).
            Provider-specific values; present on `business` profiles.
        business_address:
          type:
            - object
            - 'null'
          properties:
            line1:
              type:
                - string
                - 'null'
              description: The line 1 of the address.
            line2:
              type:
                - string
                - 'null'
              description: The line 2 of the address.
            city:
              type:
                - string
                - 'null'
              description: The city of the address.
            state:
              type:
                - string
                - 'null'
              description: The state of the address.
            postal_code:
              type:
                - string
                - 'null'
              description: The postal code of the address.
            country:
              type:
                - string
                - 'null'
              description: The country of the address.
          required:
            - line1
            - line2
            - city
            - state
            - postal_code
            - country
          description: >-
            Registered business address reported by the identity provider.
            Present on `business` profiles.
        country:
          type:
            - string
            - 'null'
          description: >-
            ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals
            this is the country of citizenship or residence reported by the
            identity provider; for businesses this is the country of
            incorporation.
        linked_companies:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The unique identifier for the company.
                example: biz_xxxxxxxxxxxxxx
              title:
                type: string
                description: The display name of the company shown to customers.
                example: Pickaxe
            required:
              - id
              - title
            description: >-
              A company is a seller on Whop. Companies own products, manage
              members, and receive payouts.
          description: >-
            The companies this identity profile is currently linked to. Only
            populated for direct Whop user sessions; always empty when
            authenticated via API key, app, or OAuth scope (a single identity
            can be linked to companies the calling platform is not entitled to
            see).
        verifications:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The numeric id of the verification record.
                example: verf_xxxxxxxxxxxxx
              status:
                $ref: '#/components/schemas/VerificationStatuses'
                description: The current status of this verification session.
              session_url:
                type:
                  - string
                  - 'null'
                description: >-
                  A URL the user can visit to complete the verification process.
                  Null if the session does not require user interaction.
                example: https://verify.stripe.com/session/abc123
              last_error_code:
                oneOf:
                  - $ref: '#/components/schemas/VerificationErrorCodes'
                  - type: 'null'
                description: >-
                  The most recent error code returned during verification. Null
                  if no error has occurred.
              last_error_reason:
                type:
                  - string
                  - 'null'
                description: >-
                  A human-readable explanation of the most recent verification
                  error. Null if no error has occurred.
                example: Document image was too blurry to read.
              created_at:
                type: string
                format: date-time
                description: When the verification record was created.
                example: '2023-12-01T05:00:00.401Z'
            required:
              - id
              - status
              - session_url
              - last_error_code
              - last_error_reason
              - created_at
            description: >-
              An identity verification session used to confirm a person or
              entity's identity for payout account eligibility.
          description: >-
            All verification attempts attached to this identity profile, ordered
            most-recent first.
        created_at:
          type: string
          format: date-time
          description: When the identity profile was first created.
          example: '2023-12-01T05:00:00.401Z'
        updated_at:
          type: string
          format: date-time
          description: When the identity profile was last synced from a verification.
          example: '2023-12-01T05:00:00.401Z'
      required:
        - id
        - profile_type
        - status
        - first_name
        - last_name
        - date_of_birth
        - email
        - phone
        - personal_address
        - business_name
        - business_structure
        - business_address
        - country
        - linked_companies
        - verifications
        - created_at
        - updated_at
      description: >-
        A consolidated identity or business profile synced from verification
        provider data.
    PageInfo:
      type: object
      properties:
        end_cursor:
          type:
            - string
            - 'null'
          description: When paginating forwards, the cursor to continue.
        start_cursor:
          type:
            - string
            - 'null'
          description: When paginating backwards, the cursor to continue.
        has_next_page:
          type: boolean
          description: When paginating forwards, are there more items?
        has_previous_page:
          type: boolean
          description: When paginating backwards, are there more items?
      required:
        - end_cursor
        - start_cursor
        - has_next_page
        - has_previous_page
      description: Information about pagination in a connection.
    VerificationStatuses:
      type: string
      enum:
        - requires_input
        - processing
        - verified
        - canceled
        - created
        - started
        - submitted
        - approved
        - declined
        - resubmission_requested
        - expired
        - abandoned
        - review
        - action_required
      description: A status for a verification.
    VerificationErrorCodes:
      type: string
      enum:
        - abandoned
        - consent_declined
        - country_not_supported
        - device_not_supported
        - document_expired
        - document_type_not_supported
        - document_unverified_other
        - email_unverified_other
        - email_verification_declined
        - id_number_insufficient_document_data
        - id_number_mismatch
        - id_number_unverified_other
        - phone_unverified_other
        - phone_verification_declined
        - selfie_document_missing_photo
        - selfie_face_mismatch
        - selfie_manipulated
        - selfie_unverified_other
        - under_supported_age
      description: An error code for a verification attempt.
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        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 ***************************`
      scheme: bearer
      bearerFormat: auth-scheme

````