List Identities

This endpoint enables you to fetch a list of Identities. You can use query parameters to filter the results returned by created_at, updated_at, summary_status and identity_type

Note that this endpoint supports pagination and returns a cursor token for fetching next pages.

GET /identity/identities

Try it

List Identities

cURL

curl --request GET \
  --url https://api.paxos.com/v2/identity/identities \
  --header 'Authorization: Bearer <token>'

200

{
  "next_page_cursor": "<string>",
  "items": [
    {
      "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
      "summary_status": "PENDING"
    }
  ]
}

OAuth Scope

identity:read_identity

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Query Parameters

summary_status · enum<string>

Summary Status of the Identity.

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

created_at.lt · string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.lte · string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.eq · string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gte · string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gt · string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.lt · string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.lte · string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.eq · string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.gte · string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.gt · string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

limit · integer<int32>

Number of results to return.

order · enum<string>

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

Available options: DESC, ASC

order_by · enum<string>

The specific method by which the returned results will be ordered.

Available options: CREATED_AT

page_cursor · string

Cursor token for fetching the next page.

identity_type · enum<string>

Optionally filter by Identity type

Available options: PERSON, INSTITUTION

Response

200 - application/json

A successful response.

next_page_cursor · string

Cursor token required for fetching the next page.

items · object[]

The result list of identities.

Show child attributes

items. id · string · required

items. metadata · API User-facing metadata · object

Show child attributes

items.metadata. {key} · string

items. summary_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items. user_disabled · boolean

items. admin_disabled · boolean

items. person_details · object

Show child attributes

items.person_details. id_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.person_details. sanctions_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.person_details. first_name · string

Maximum string length: 200

items.person_details. last_name · string

Maximum string length: 200

items.person_details. date_of_birth · string

items.person_details. govt_id · string

Maximum string length: 200

items.person_details. address · object

A mailing address.

Show child attributes

items.person_details.address. country · string · required

Maximum string length: 35

items.person_details.address. address1 · string · required

Maximum string length: 35

items.person_details.address. city · string · required

Maximum string length: 35

items.person_details.address. province · string · required

Maximum string length: 35

items.person_details.address. address2 · string

To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").

Maximum string length: 35

items.person_details.address. zip_code · string

Maximum string length: 35

items.person_details. phone_number · string

items.person_details. email · string

items.person_details. nationality · string

Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.

items.person_details. verifier_id · string

Allowed in create and update. The id used by the external verifier.

items.person_details. verifier_type · enum<string>

Available options: PAXOS, PASSTHROUGH, MANUAL

items.person_details. id_verification_url · string

items.person_details. passthrough_verifier_type · enum<string>

Available options: JUMIO, ALLOY, LEXISNEXIS, MITEK, SUMSUB, MICROBILT, ONFIDO, CUSTOMER, EQUIFAX, ID3_AUTHENTICATE, FIS, PROVE, PERSONA, PLAID, DOTFILE

items.person_details. passthrough_verified_at · string<date-time>

items.person_details. govt_id_type · enum<string>

Available options: SSN, ID_CARD, ITIN, PASSPORT, DRIVING_LICENSE, VISA

items.person_details. cip_id · string

Maximum string length: 200

items.person_details. cip_id_type · enum<string>

Available options: SSN, ID_CARD, ITIN, PASSPORT, DRIVING_LICENSE, VISA

items.person_details. cip_id_country · string

Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.

items.person_details. additional_screening_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.person_details. profession · string

Allowed in create and update.

items.person_details. middle_name · string

Maximum string length: 200

items.person_details. country_of_birth · string

Allowed in create and update.

items.person_details. passthrough_verification_id · string

Unique identifier for the underlying person's ID verification record.

items.person_details. passthrough_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.person_details. passthrough_verification_fields · enum<string>[]

List of verification fields used by the external verifier to validate the person's identity.

Available options: FULL_LEGAL_NAME, ADDRESS, DATE_OF_BIRTH, CIP_ID

items. type · enum<string>

Available options: PERSON, INSTITUTION

items. ref_id · string

A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user.

items. institution_details · object

Show child attributes

items.institution_details. sanctions_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.institution_details. name · string

Maximum string length: 200

items.institution_details. business_address · object

A mailing address.

Show child attributes

items.institution_details.business_address. country · string · required

Maximum string length: 35

items.institution_details.business_address. address1 · string · required

Maximum string length: 35

items.institution_details.business_address. city · string · required

Maximum string length: 35

items.institution_details.business_address. province · string · required

Maximum string length: 35

items.institution_details.business_address. address2 · string

To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").

Maximum string length: 35

items.institution_details.business_address. zip_code · string

Maximum string length: 35

items.institution_details. phone_number · string

items.institution_details. email · string

items.institution_details. institution_type · enum<string>

Available options: TRUST, CORPORATION, LLC, PARTNERSHIP

items.institution_details. institution_sub_type · enum<string>

Available options: INVESTMENT, HEDGE_FUND, MONEY_SERVICE_BUSINESS, STO_ISSUER, PRECIOUS_METALS, NON_PROFIT, REGISTERED_INVESTMENT_ADVISOR, AGRICULTURE_FORESTRY_FISHING_HUNTING, MINING, UTILITIES, CONSTRUCTION, MANUFACTURING, WHOLESALE_TRADE, RETAIL_TRADE, TRANSPORTATION_WAREHOUSING, INFORMATION, FINANCE_INSURANCE, REAL_ESTATE_RENTAL_LEASING, PROFESSIONAL_SCIENTIFIC_TECHNICAL_SERVICES, MANAGEMENT_OF_COMPANIES_ENTERPRISES, ADMINISTRATIVE_SUPPORT_WASTE_MANAGEMENT_REMEDIATION_SERVICES, EDUCATIONAL_SERVICES, HEALTH_CARE_SOCIAL_ASSISTANCE, ARTS_ENTERTAINMENT_RECREATION, ACCOMMODATION_FOOD_SERVICES, OTHER_SERVICES, PUBLIC_ADMINISTRATION, NOT_CLASSIFIED, ADULT_ENTERTAINMENT, AUCTIONS, AUTOMOBILES, BLOCKCHAIN, CRYPTO, DRUGS, EXPORT_IMPORT, E_COMMERCE, FINANCIAL_INSTITUTION, GAMBLING, INSURANCE, MARKET_MAKER, SHELL_BANK, TRAVEL_TRANSPORT, WEAPONS

items.institution_details. cip_id · string

Maximum string length: 200

items.institution_details. cip_id_type · enum<string>

Available options: EIN, SSN, ITIN, REGISTRATION_NUMBER

items.institution_details. cip_id_country · string

Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.

items.institution_details. govt_registration_date · string<date-time>

items.institution_details. incorporation_address · object

A mailing address.

Show child attributes

items.institution_details.incorporation_address. country · string · required

Maximum string length: 35

items.institution_details.incorporation_address. address1 · string · required

Maximum string length: 35

items.institution_details.incorporation_address. city · string · required

Maximum string length: 35

items.institution_details.incorporation_address. province · string · required

Maximum string length: 35

items.institution_details.incorporation_address. address2 · string

To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").

Maximum string length: 35

items.institution_details.incorporation_address. zip_code · string

Maximum string length: 35

items.institution_details. regulation_status · enum<string>

Available options: US_REGULATED, INTL_REGULATED, NON_REGULATED

items.institution_details. trading_type · enum<string>

Available options: PRIVATE, PUBLIC, PUBLICLY_TRADED_SUBSIDIARY

items.institution_details. listed_exchange · string

items.institution_details. ticker_symbol · string

Ticker symbol of the institution if publicly traded or ticker symbol of the parent institution.

items.institution_details. parent_institution_name · string

items.institution_details. regulator_name · string

items.institution_details. regulator_jurisdiction · string

items.institution_details. regulator_register_number · string

items.institution_details. document_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.institution_details. additional_screening_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.institution_details. doing_business_as · string

items.institution_details. business_description · string

items. institution_members · members associated with institution identity type · object[]

Show child attributes

items.institution_members. identity_id · string

items.institution_members. roles · enum<string>[]

Available options: BENEFICIAL_OWNER, ACCOUNT_OPENER, TRUSTEE, AUTHORIZED_USER, GRANTOR, MANAGEMENT_CONTROL_PERSON, BENEFICIARY

items.institution_members. ownership · string

Decimal number representing the percent ownership the identity has in the company-- e.g. 5 represents 5% ownership.

items.institution_members. position · string

items.institution_members. name · string

items.institution_members. summary_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

items.institution_members. id · string

Institution member ID. Note: This field is auto-generated. Specifying an ID when creating an institution member is a client error.

items. created_at · string<date-time>

The time at which the identity is created at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

items. updated_at · string<date-time>

The time at which the identity is updated at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

items. tax_details · tax payer details · object[]

Show child attributes

items.tax_details. tax_payer_id · string

Maximum string length: 35

items.tax_details. tax_payer_country · string

items.tax_details. tin_verification_status · enum<string>

The TIN verification status for the associated tax_payer_id.

Available options: TIN_VERIFICATION_PENDING, TIN_VERIFICATION_ERROR, TIN_VERIFICATION_VALID

items. tax_details_not_required · boolean

items. summary_tin_verification_status · enum<string>

The TIN verification status for the associated tax_payer_id.

Available options: TIN_VERIFICATION_PENDING, TIN_VERIFICATION_ERROR, TIN_VERIFICATION_VALID

items. customer_due_diligence · object

Show child attributes

items.customer_due_diligence. aliases · string[]

A list of alternate names or aliases associated with the Identity.

items.customer_due_diligence. estimated_net_worth · enum<string>

Available options: NET_WORTH_0_TO_100K, NET_WORTH_100K_TO_500K, NET_WORTH_500K_TO_1M, NET_WORTH_1M_TO_2_5M, NET_WORTH_2_5M_TO_5M, NET_WORTH_5M_TO_7_5M, NET_WORTH_7_5M_TO_10M, NET_WORTH_10M_TO_25M, NET_WORTH_25M_TO_50M, NET_WORTH_OVER_50M

items.customer_due_diligence. estimated_yearly_income · enum<string>

Available options: INCOME_0_TO_50K, INCOME_50K_TO_100K, INCOME_100K_TO_250K, INCOME_250K_TO_500K, INCOME_500K_TO_750K, INCOME_750K_TO_1M, INCOME_ABOVE_1M

items.customer_due_diligence. expected_transfer_value · enum<string>

Available options: TRANSFER_VALUE_0_TO_25K, TRANSFER_VALUE_25K_TO_50K, TRANSFER_VALUE_50K_TO_100K, TRANSFER_VALUE_100K_TO_250K, TRANSFER_VALUE_250K_TO_500K, TRANSFER_VALUE_500K_TO_750K, TRANSFER_VALUE_750K_TO_1M, TRANSFER_VALUE_1M_TO_2_5M, TRANSFER_VALUE_2_5M_TO_5M, TRANSFER_VALUE_ABOVE_5M

items.customer_due_diligence. source_of_wealth · enum<string>

Available options: INHERITANCE, INVESTMENT_GAINS, BUSINESS_OWNERSHIP_DIVIDENDS, EMPLOYMENT_INCOME, REAL_ESTATE, OTHER_SOURCE_OF_WEALTH

items.customer_due_diligence. source_of_funds · enum<string>

Available options: SALARY_DISBURSEMENT, INHERITANCE_DISTRIBUTION, INVESTMENT_RETURNS, BUSINESS_DIVIDENDS_PROFITS, PROPERTY_SALE, LOAN_DISBURSEMENT, SAVINGS_ACCOUNT_WITHDRAWAL, GOVERNMENT_BENEFITS

items.customer_due_diligence. purpose_of_account · enum<string>

Available options: INVESTMENT_TRADING, SAVINGS, STABLECOIN_PURCHASE_REDEMPTION

items.customer_due_diligence. employment_status · enum<string>

Available options: CONTRACTUAL, FULL_TIME, PART_TIME, RETIRED, SELF_EMPLOYED, STUDENT, UNEMPLOYED

items.customer_due_diligence. employment_industry_sector · enum<string>

Available options: INVESTMENT, HEDGE_FUND, MONEY_SERVICE_BUSINESS, STO_ISSUER, PRECIOUS_METALS, NON_PROFIT, REGISTERED_INVESTMENT_ADVISOR, AGRICULTURE_FORESTRY_FISHING_HUNTING, MINING, UTILITIES, CONSTRUCTION, MANUFACTURING, WHOLESALE_TRADE, RETAIL_TRADE, TRANSPORTATION_WAREHOUSING, INFORMATION, FINANCE_INSURANCE, REAL_ESTATE_RENTAL_LEASING, PROFESSIONAL_SCIENTIFIC_TECHNICAL_SERVICES, MANAGEMENT_OF_COMPANIES_ENTERPRISES, ADMINISTRATIVE_SUPPORT_WASTE_MANAGEMENT_REMEDIATION_SERVICES, EDUCATIONAL_SERVICES, HEALTH_CARE_SOCIAL_ASSISTANCE, ARTS_ENTERTAINMENT_RECREATION, ACCOMMODATION_FOOD_SERVICES, OTHER_SERVICES, PUBLIC_ADMINISTRATION, NOT_CLASSIFIED, ADULT_ENTERTAINMENT, AUCTIONS, AUTOMOBILES, BLOCKCHAIN, CRYPTO, DRUGS, EXPORT_IMPORT, E_COMMERCE, FINANCIAL_INSTITUTION, GAMBLING, INSURANCE, MARKET_MAKER, SHELL_BANK, TRAVEL_TRANSPORT, WEAPONS

items.customer_due_diligence. industry_sector · enum<string>

Available options: INVESTMENT, HEDGE_FUND, MONEY_SERVICE_BUSINESS, STO_ISSUER, PRECIOUS_METALS, NON_PROFIT, REGISTERED_INVESTMENT_ADVISOR, AGRICULTURE_FORESTRY_FISHING_HUNTING, MINING, UTILITIES, CONSTRUCTION, MANUFACTURING, WHOLESALE_TRADE, RETAIL_TRADE, TRANSPORTATION_WAREHOUSING, INFORMATION, FINANCE_INSURANCE, REAL_ESTATE_RENTAL_LEASING, PROFESSIONAL_SCIENTIFIC_TECHNICAL_SERVICES, MANAGEMENT_OF_COMPANIES_ENTERPRISES, ADMINISTRATIVE_SUPPORT_WASTE_MANAGEMENT_REMEDIATION_SERVICES, EDUCATIONAL_SERVICES, HEALTH_CARE_SOCIAL_ASSISTANCE, ARTS_ENTERTAINMENT_RECREATION, ACCOMMODATION_FOOD_SERVICES, OTHER_SERVICES, PUBLIC_ADMINISTRATION, NOT_CLASSIFIED, ADULT_ENTERTAINMENT, AUCTIONS, AUTOMOBILES, BLOCKCHAIN, CRYPTO, DRUGS, EXPORT_IMPORT, E_COMMERCE, FINANCIAL_INSTITUTION, GAMBLING, INSURANCE, MARKET_MAKER, SHELL_BANK, TRAVEL_TRANSPORT, WEAPONS

items.customer_due_diligence. has_underlying_trust_structure · boolean

Whether or not the institution tied to the Identity has an underlying trust structure.

items.customer_due_diligence. has_nominee_shareholders · boolean

Whether or not the institution tied to the Identity has nominee shareholders.

items.customer_due_diligence. created_at · string<date-time>

items.customer_due_diligence. is_publicly_traded · boolean

true or false indicating whether or not the company is listed on a public stock exchange.

items.customer_due_diligence. merchant_funding_source · enum<string>

Available options: BUSINESS_LOANS_FINANCING, SALARY_SAVINGS, INVESTMENT_GAINS, INHERITANCE, REAL_ESTATE_INCOME, NON_PROFIT_SOURCES, OTHER_BUSINESS_INCOME

items.customer_due_diligence. customer_regions · enum<string>[]

Regions where the customer base is located.

Available options: US_CANADA, MEXICO_CENTRAL_AMERICA, SOUTH_AMERICA, EUROPE, ASIA, AFRICA, OCEANIA

items. is_merchant · boolean

True if the identity is a merchant.

items. last_kyc_refresh_date · string<date-time>

The last timestamp the identity has undergone a periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.