--- title: "List Identities" method: GET path: "/identity/identities" tags: ["Identity"] --- # List Identities `GET /identity/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. ## Query parameters - `summary_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `created_at.lt` string, date-time - `created_at.lte` string, date-time - `created_at.eq` string, date-time - `created_at.gte` string, date-time - `created_at.gt` string, date-time - `updated_at.lt` string, date-time - `updated_at.lte` string, date-time - `updated_at.eq` string, date-time - `updated_at.gte` string, date-time - `updated_at.gt` string, date-time - `limit` integer - `order` 'DESC' | 'ASC' - `order_by` 'CREATED_AT' - `page_cursor` string - `identity_type` 'PERSON' | 'INSTITUTION' - `control_types` string[] - `control_reason_codes` string[] ## Response `200` A successful response. - ListIdentitiesResponse - `next_page_cursor` string — Cursor token required for fetching the next page. - `items` Identity[] — The result list of identities. - `id` string, required - `metadata` object - `status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `status_details` IdentityStatusDetails - `active_controls` IdentityControl[] — Identity controls currently active on this identity. - `id` string, required - `type` 'SELL_ONLY' | 'CLOSED' | 'FROZEN' | 'DORMANT', required - `set_by` 'SET_BY_PAXOS' | 'SET_BY_CLIENT', required - `is_overridable` boolean - `reason_code` 'OTHER' | 'END_USER_REQUEST' | 'INACTIVITY' | 'COMPLIANCE_KYC' | 'COMPLIANCE_EDD' | 'COMPLIANCE_SCREENING' | 'COMPLIANCE_INVESTIGATION' | 'COMPLIANCE_INCOMPLETE' | 'RISK_FRAUD' | 'LEGAL_ORDER' | 'ADMINISTRATIVE' — - OTHER: Miscellaneous reason not captured by existing categories. - END_USER_REQUEST: Control applied at the end user's request. - INACTIVITY: Control applied due to prolonged inactivity in accordance with dormancy or lifecycle management policies. - COMPLIANCE_KYC: Control applied due to unmet KYC requirements, including missing, expired, failed, or unresponsiveness to refresh obligations. - COMPLIANCE_EDD: Control applied due to Enhanced Due Diligence (EDD) requirements, including failure to complete EDD reviews, provide requested information, or satisfy heightened risk assessment criteria. - COMPLIANCE_SCREENING: Control applied as a result of sanctions, politically exposed person (PEP), or adverse media screening hits. - COMPLIANCE_INVESTIGATION: Control applied while an identity is under active compliance, risk, or regulatory investigation, including reviews triggered by monitoring alerts or external inquiries. - COMPLIANCE_INCOMPLETE: Control applied because the onboarding process was not successfully completed, including failure to respond to requests for information or provide required documentation. - RISK_FRAUD: Control applied due to suspected or confirmed fraud, abuse, or security risk, including account compromise, transaction fraud, or policy violations. - LEGAL_ORDER: Control applied to comply with a legal, regulatory, or law-enforcement directive, including court orders, asset preservation requests, or regulatory instructions. - ADMINISTRATIVE: Control applied for operational or platform-initiated reasons not attributable to the end user or compliance failure, such as system remediation or account restructuring. - `reason` string - `created_at` string, date-time, required - `deleted_at` string, date-time - `requirements` IdentityRequirement[] — Requirements that must be fulfilled for this identity to become approved. - `type` 'ID_VERIFICATION' | 'DOCUMENT_VERIFICATION' | 'SCREENING_CHECK' | 'COMPLIANCE_CHECK' | 'ENHANCED_DUE_DILIGENCE' | 'MEMBERS' | 'KYC_REFRESH' | 'TAX_DETAILS_VERIFICATION', required — RequirementType identifies the category of requirement blocking or pending for an identity. - ID_VERIFICATION: Identity verification via a passthrough provider is pending or failed. - DOCUMENT_VERIFICATION: Document review for an institution is pending or failed. - SCREENING_CHECK: Identity screening check is pending or failed. - COMPLIANCE_CHECK: A compliance check is pending or failed. - ENHANCED_DUE_DILIGENCE: Enhanced due diligence review is pending or failed. - MEMBERS: One or more institution members have a non-approved status. - KYC_REFRESH: KYC refresh is overdue or in progress. - TAX_DETAILS_VERIFICATION: Tax details verification is pending or failed. - `errors` IdentityRequirementError[], required — Specific errors providing additional detail on why this requirement is blocked. - `code` 'IDENTITY_VERIFICATION_FAILED' | 'DOCUMENT_VERIFICATION_FAILED' | 'SCREENING_IN_PROGRESS' | 'SCREENING_FAILED' | 'KYC_REFRESH_OVERDUE' | 'MEMBER_VERIFICATION_FAILED' | 'MEMBER_VERIFICATION_PENDING' | 'EDD_DOCUMENTATION_REQUIRED' | 'COMPLIANCE_REVIEW_REQUIRED' | 'COMPLIANCE_REVIEW_FAILED' | 'TIN_NOT_FOUND' | 'IDENTITY_VERIFICATION_REQUIRED' | 'DOCUMENT_UPLOAD_REQUIRED' | 'KYC_REFRESH_REQUIRED', required — Code identifies the specific failure type. Additional codes may be added as new requirement types are introduced. - `description` string, required — Human-readable description providing additional context for the error. Do not expose code or description values directly to end users. - `status` 'PENDING' | 'FAILED', required — RequirementStatus indicates whether this requirement is pending or has failed. PENDING means the check is in progress or awaiting information. FAILED means the check did not pass and may block approval. - `awaiting_action_from` 'CLIENT' | 'PAXOS' — AwaitingActionFrom indicates who needs to take action to unblock this requirement. Not set for MEMBERS requirements, where the client should call GetIdentity on each member identity to determine their individual requirement status. - CLIENT: The client (the integrating partner) must take action to resolve this requirement. - PAXOS: Paxos is handling this; no action needed from the client. - `summary_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `user_disabled` boolean — Deprecated: use `status_details.active_controls` instead. - `admin_disabled` boolean — Deprecated: use `status_details.active_controls` instead. - `person_details` PersonDetails - `id_verification_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `sanctions_verification_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `first_name` string - `last_name` string - `date_of_birth` string - `govt_id` string - `address` IdentityMailingAddress — A mailing address. - `country` string, required - `address1` string, required - `address2` string — To clear address2 (i.e. when updating an identity), set address2 to an empty string (""). - `city` string, required - `province` string, required - `zip_code` string — Required for countries that have postal or zip codes. - `phone_number` string - `email` string - `nationality` string — Allowed in create and update. Must be an ISO 3166-1 alpha 3 code. - `verifier_id` string — Allowed in create and update. The id used by the external verifier. Must not be set when `verifier_type` is `PASSTHROUGH`, `PAXOS`, or `MANUAL`. - `verifier_type` 'PAXOS' | 'PASSTHROUGH' | 'MANUAL' - `id_verification_url` string - `passthrough_verifier_type` 'JUMIO' | 'ALLOY' | 'LEXISNEXIS' | 'MITEK' | 'SUMSUB' | 'MICROBILT' | 'ONFIDO' | 'CUSTOMER' | 'EQUIFAX' | 'ID3_AUTHENTICATE' | 'FIS' | 'PROVE' | 'PERSONA' | 'PLAID' | 'DOTFILE' | 'AIPRISE' - `passthrough_verified_at` string, date-time — Required when `verifier_type` is `PASSTHROUGH`. Specifies the time that your ID verification process was completed. - `govt_id_type` 'SSN' | 'ID_CARD' | 'ITIN' | 'PASSPORT' | 'DRIVING_LICENSE' | 'VISA' - `cip_id` string - `cip_id_type` 'SSN' | 'ID_CARD' | 'ITIN' | 'PASSPORT' | 'DRIVING_LICENSE' | 'VISA' - `cip_id_country` string — Allowed in create and update. Must be an ISO 3166-1 alpha 3 code. - `additional_screening_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `profession` string — Allowed in create and update. - `middle_name` string - `country_of_birth` string — Allowed in create and update. - `passthrough_verification_id` string — Unique identifier for the underlying person's ID verification record. - `passthrough_verification_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `passthrough_verification_fields` PassthroughVerificationField[] — List of verification fields used by the external verifier to validate the person's identity. - `type` 'PERSON' | 'INSTITUTION' - `ref_id` string — A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user. - `institution_details` InstitutionDetails - `sanctions_verification_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `name` string - `business_address` IdentityMailingAddress — A mailing address. - `country` string, required - `address1` string, required - `address2` string — To clear address2 (i.e. when updating an identity), set address2 to an empty string (""). - `city` string, required - `province` string, required - `zip_code` string — Required for countries that have postal or zip codes. - `phone_number` string - `email` string - `institution_type` 'TRUST' | 'CORPORATION' | 'LLC' | 'PARTNERSHIP' | 'SOLE_PROPRIETORSHIP' - `institution_sub_type` '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' - `cip_id` string - `cip_id_type` 'EIN' | 'SSN' | 'ITIN' | 'REGISTRATION_NUMBER' - `cip_id_country` string — Allowed in create and update. Must be an ISO 3166-1 alpha 3 code. - `govt_registration_date` string, date-time - `incorporation_address` IdentityMailingAddress — A mailing address. - `country` string, required - `address1` string, required - `address2` string — To clear address2 (i.e. when updating an identity), set address2 to an empty string (""). - `city` string, required - `province` string, required - `zip_code` string — Required for countries that have postal or zip codes. - `regulation_status` 'US_REGULATED' | 'INTL_REGULATED' | 'NON_REGULATED' - `trading_type` 'PRIVATE' | 'PUBLIC' | 'PUBLICLY_TRADED_SUBSIDIARY' - `listed_exchange` string - `ticker_symbol` string — Ticker symbol of the institution if publicly traded or ticker symbol of the parent institution. - `parent_institution_name` string - `regulator_name` string - `regulator_jurisdiction` string - `regulator_register_number` string - `document_verification_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `additional_screening_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `doing_business_as` string - `business_description` string - `institution_members` InstitutionMember[] - `identity_id` string, required - `roles` InstitutionRoleType[] — The role(s) the member fulfils for the institution. Should always be present in practice. See the [developer guide](https://docs.paxos.com/guides/identity/institution-types) for required roles per institution type. - `ownership` string, decimal — Decimal number representing the percent ownership the identity has in the company-- e.g. 5 represents 5% ownership. - `position` string - `name` string - `summary_status` 'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED' - `id` string — Institution member ID. Note: This field is auto-generated. Specifying an ID when creating an institution member is a client error. - `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`. - `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`. - `tax_details` TaxDetail[] - `tax_payer_id` string - `tax_payer_country` string - `tin_verification_status` 'TIN_VERIFICATION_PENDING' | 'TIN_VERIFICATION_ERROR' | 'TIN_VERIFICATION_VALID' — The TIN verification status for the associated `tax_payer_id`. - `tax_details_not_required` boolean - `summary_tin_verification_status` 'TIN_VERIFICATION_PENDING' | 'TIN_VERIFICATION_ERROR' | 'TIN_VERIFICATION_VALID' — The TIN verification status for the associated `tax_payer_id`. - `customer_due_diligence` CustomerDueDiligence - `aliases` string[] — A list of alternate names or aliases associated with the Identity. - `estimated_net_worth` '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' - `estimated_yearly_income` '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' - `expected_transfer_value` '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' — Anticipated monthly volume. The expected transfer value range for the Account associated with the Identity. - `source_of_wealth` 'INHERITANCE' | 'INVESTMENT_GAINS' | 'BUSINESS_OWNERSHIP_DIVIDENDS' | 'EMPLOYMENT_INCOME' | 'REAL_ESTATE' | 'OTHER_SOURCE_OF_WEALTH' - `source_of_funds` 'SALARY_DISBURSEMENT' | 'INHERITANCE_DISTRIBUTION' | 'INVESTMENT_RETURNS' | 'BUSINESS_DIVIDENDS_PROFITS' | 'PROPERTY_SALE' | 'LOAN_DISBURSEMENT' | 'SAVINGS_ACCOUNT_WITHDRAWAL' | 'GOVERNMENT_BENEFITS' - `purpose_of_account` 'INVESTMENT_TRADING' | 'SAVINGS' | 'STABLECOIN_PURCHASE_REDEMPTION' - `employment_status` 'CONTRACTUAL' | 'FULL_TIME' | 'PART_TIME' | 'RETIRED' | 'SELF_EMPLOYED' | 'STUDENT' | 'UNEMPLOYED' - `employment_industry_sector` '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' - `industry_sector` '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' - `has_underlying_trust_structure` boolean — Whether or not the institution tied to the Identity has an underlying trust structure. - `has_nominee_shareholders` boolean — Whether or not the institution tied to the Identity has nominee shareholders. - `created_at` string, date-time - `is_publicly_traded` boolean — `true` or `false` indicating whether or not the company is listed on a public stock exchange. - `merchant_funding_source` 'BUSINESS_LOANS_FINANCING' | 'SALARY_SAVINGS' | 'INVESTMENT_GAINS' | 'INHERITANCE' | 'REAL_ESTATE_INCOME' | 'NON_PROFIT_SOURCES' | 'OTHER_BUSINESS_INCOME' - `customer_regions` CustomerRegion[] — Regions where the customer base is located. - `is_merchant` boolean — True if the identity is a merchant. - `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`. --- [API](https://skmtc.net/paxos/apis/paxos-api.md) · [All operations](https://skmtc.net/paxos/apis/paxos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paxos/paxos-api/revisions/0687ca8c9a8d/schema)