Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Identity profiles

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
get/identity_profiles

Query parameters

afterstring nullable

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

beforestring nullable

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

firstinteger nullable

Returns the first n elements from the list.

Example:42
lastinteger nullable

Returns the last n elements from the list.

Example:42
company_idstring nullable

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

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"
        }
      ]
    }
  ]
}