FIfinix
Identities

List Identities

Changed on

Retrieve a list the previously created Identities.

For details on how to query endpoints using the available parameters, see Query Parameters.

{% admonition type="info" %} If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter. {% /admonition %}

get/identities

Request

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

business_namestring
Example:Finix%20Flowers

Filter by the full business name. Partial business names are not supported.

business_type'INDIVIDUAL_SOLE_PROPRIETORSHIP' | 'CORPORATION' | 'LIMITED_LIABILITY_COMPANY' | 'PARTNERSHIP' | 'LIMITED_PARTNERSHIP' | 'GENERAL_PARTNERSHIP' | 'ASSOCIATION_ESTATE_TRUST' | 'TAX_EXEMPT_ORGANIZATION' | 'GOVERNMENT_AGENCY'
Example:INDIVIDUAL_SOLE_PROPRIETORSHIP

Filter by the business type. Partial business types are not supported.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

default_statement_descriptorstring
Example:Finix%20Flowers

Filter by the default_statement_descriptor.

emailstring
Example:user@example.org

Filter by the email address or email domain. Partial emails are not supported.

first_namestring
Example:John

Filter by the first name of the person associated to the Identity.

idstring

Filter by id.

identity_role'APPLICATION_OWNER' | 'BENEFICIAL_OWNER' | 'BUYER' | 'PLATFORM_OWNER' | 'RECIPIENT' | 'SELLER' | 'SENDER'
Example:SELLER

Filter by the role of the person associated to the Identity.

last_namestring
Example:Smith

Filter by the last name of the person associated to the Identity.

limitinteger
Example:10

The numbers of items to return.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

titlestring
Example:ceo

Filter by the title if available.

type'BUSINESS' | 'PERSONAL'
Example:BUSINESS

Filter by the type of Identity.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Identity objects

Changes

  • adb3c5058a74Revision changes
    • info

      added the new optional query request parameter identity_role

    • info

      added the new optional query request parameter type

  • 7919e33b4853Revision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the //// response's property type changed from no type to object for status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      removed from the //// response property allOf list for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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