Sign in
Identity profiles

List identity profiles

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

Required permissions:

  • identity:read
get/identity_profiles

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

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

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

Changed in 4 of the 74 revisions of this API.2715

  • 697924df40d111See the full diff
    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    • ○

      added the new optional query request parameter account_id

      new-optional-request-parameter

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f67a043e3190210See the full diff
    • ▲

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

      request-parameter-became-enum

    • ▲

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

      request-parameter-became-enum

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

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

      request-parameter-type-generalized

    • ○

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

      request-parameter-type-generalized

  • 099fdc3be42251See the full diff
    • ●

      added the new blocked_by_parent enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new denied enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual_review enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual_review enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual_review enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value manual_review to the property oneOf[IdentityProfileStatuses]/ of the query request parameter status

      request-parameter-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc13See the full diff
    • ●

      added the new action_required enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value action_required to the property oneOf[IdentityProfileStatuses]/ of the query request parameter status

      request-parameter-property-enum-value-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.