API Documentation
Deposits and Withdrawals
Profiles
Sandbox
Settlements
Orchestrations / Conversions
Taxes
Trading
Rewards
Events
API Credentials
Websockets
Webhooks
curl --request PUT \
--url https://api.paxos.com/v2/identity/identities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"person_details": {
"first_name": "John"
}
}
'{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"summary_status": "PENDING"
}Update Identity
Updates an Identity, this action performs a delta of what is submitted in the update and the existing identity.
- Updating details (
person_detailsorinstitution_details) might lead to the identity being re-verified (e.g. re-screening name changes), which could impact the identity’s ability to transact on the Platform. - Setting
set_user_disabledtotruewill make the IdentityDISABLED(read more here on what this means) - Setting
tax_detailswill update all the tax details for the identity - Setting
last_kyc_refresh_dateindicates this is not an adhoc-update, and instead an update for a periodic kyc refresh
Changing an Institution Identity to a Person and vice-versa is not supported.
curl --request PUT \
--url https://api.paxos.com/v2/identity/identities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"person_details": {
"first_name": "John"
}
}
'{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"summary_status": "PENDING"
}identity:write_identity
Authorizations
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 →
Path Parameters
Body
Show child attributes
Show child attributes
PENDING, ERROR, APPROVED, DENIED, DISABLED PENDING, ERROR, APPROVED, DENIED, DISABLED 200200200A mailing address.
Show child attributes
Show child attributes
35353535To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").
3535Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.
Allowed in create and update. The id used by the external verifier.
PAXOS, PASSTHROUGH, MANUAL JUMIO, ALLOY, LEXISNEXIS, MITEK, SUMSUB, MICROBILT, ONFIDO, CUSTOMER, EQUIFAX, ID3_AUTHENTICATE, FIS, PROVE, PERSONA, PLAID, DOTFILE SSN, ID_CARD, ITIN, PASSPORT, DRIVING_LICENSE, VISA 200SSN, ID_CARD, ITIN, PASSPORT, DRIVING_LICENSE, VISA Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.
PENDING, ERROR, APPROVED, DENIED, DISABLED Allowed in create and update.
200Allowed in create and update.
Unique identifier for the underlying person's ID verification record.
PENDING, ERROR, APPROVED, DENIED, DISABLED List of verification fields used by the external verifier to validate the person's identity.
FULL_LEGAL_NAME, ADDRESS, DATE_OF_BIRTH, CIP_ID true disables the identity. false re-enables it, unless it has been disabled by a Paxos admin.
Show child attributes
Show child attributes
PENDING, ERROR, APPROVED, DENIED, DISABLED 200A mailing address.
Show child attributes
Show child attributes
35353535To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").
3535TRUST, CORPORATION, LLC, PARTNERSHIP 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 200EIN, SSN, ITIN, REGISTRATION_NUMBER Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.
A mailing address.
Show child attributes
Show child attributes
35353535To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").
3535US_REGULATED, INTL_REGULATED, NON_REGULATED PRIVATE, PUBLIC, PUBLICLY_TRADED_SUBSIDIARY Ticker symbol of the institution if publicly traded or ticker symbol of the parent institution.
PENDING, ERROR, APPROVED, DENIED, DISABLED PENDING, ERROR, APPROVED, DENIED, DISABLED A user-facing ID to prevent duplicate identity creation. Unique for all identities created by the same API user.
Show child attributes
Show child attributes
Set to true if tax details are not legally required.
Show child attributes
Show child attributes
A list of alternate names or aliases associated with the Identity.
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 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 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 INHERITANCE, INVESTMENT_GAINS, BUSINESS_OWNERSHIP_DIVIDENDS, EMPLOYMENT_INCOME, REAL_ESTATE, OTHER_SOURCE_OF_WEALTH SALARY_DISBURSEMENT, INHERITANCE_DISTRIBUTION, INVESTMENT_RETURNS, BUSINESS_DIVIDENDS_PROFITS, PROPERTY_SALE, LOAN_DISBURSEMENT, SAVINGS_ACCOUNT_WITHDRAWAL, GOVERNMENT_BENEFITS INVESTMENT_TRADING, SAVINGS, STABLECOIN_PURCHASE_REDEMPTION CONTRACTUAL, FULL_TIME, PART_TIME, RETIRED, SELF_EMPLOYED, STUDENT, UNEMPLOYED 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 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 Whether or not the institution tied to the Identity has an underlying trust structure.
Whether or not the institution tied to the Identity has nominee shareholders.
true or false indicating whether or not the company is listed on a public stock exchange.
BUSINESS_LOANS_FINANCING, SALARY_SAVINGS, INVESTMENT_GAINS, INHERITANCE, REAL_ESTATE_INCOME, NON_PROFIT_SOURCES, OTHER_BUSINESS_INCOME Regions where the customer base is located.
US_CANADA, MEXICO_CENTRAL_AMERICA, SOUTH_AMERICA, EUROPE, ASIA, AFRICA, OCEANIA Set to true to indicate that this identity is a merchant.
Set to the timestamp the identity has last undergone a periodic kyc refresh. If unset, the update is not for
periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
Response
A successful response.
PENDING, ERROR, APPROVED, DENIED, DISABLED Show child attributes
Show child attributes
PENDING, ERROR, APPROVED, DENIED, DISABLED PENDING, ERROR, APPROVED, DENIED, DISABLED 200200200A mailing address.
Show child attributes
Show child attributes
35353535To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").
3535Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.
Allowed in create and update. The id used by the external verifier.
PAXOS, PASSTHROUGH, MANUAL JUMIO, ALLOY, LEXISNEXIS, MITEK, SUMSUB, MICROBILT, ONFIDO, CUSTOMER, EQUIFAX, ID3_AUTHENTICATE, FIS, PROVE, PERSONA, PLAID, DOTFILE SSN, ID_CARD, ITIN, PASSPORT, DRIVING_LICENSE, VISA 200SSN, ID_CARD, ITIN, PASSPORT, DRIVING_LICENSE, VISA Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.
PENDING, ERROR, APPROVED, DENIED, DISABLED Allowed in create and update.
200Allowed in create and update.
Unique identifier for the underlying person's ID verification record.
PENDING, ERROR, APPROVED, DENIED, DISABLED List of verification fields used by the external verifier to validate the person's identity.
FULL_LEGAL_NAME, ADDRESS, DATE_OF_BIRTH, CIP_ID PERSON, INSTITUTION A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user.
Show child attributes
Show child attributes
PENDING, ERROR, APPROVED, DENIED, DISABLED 200A mailing address.
Show child attributes
Show child attributes
35353535To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").
3535TRUST, CORPORATION, LLC, PARTNERSHIP 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 200EIN, SSN, ITIN, REGISTRATION_NUMBER Allowed in create and update. Must be an ISO 3166-1 alpha 3 code.
A mailing address.
Show child attributes
Show child attributes
35353535To clear address2 (i.e. when updating an identity), set address2 to an empty string ("").
3535US_REGULATED, INTL_REGULATED, NON_REGULATED PRIVATE, PUBLIC, PUBLICLY_TRADED_SUBSIDIARY Ticker symbol of the institution if publicly traded or ticker symbol of the parent institution.
PENDING, ERROR, APPROVED, DENIED, DISABLED PENDING, ERROR, APPROVED, DENIED, DISABLED Show child attributes
Show child attributes
BENEFICIAL_OWNER, ACCOUNT_OPENER, TRUSTEE, AUTHORIZED_USER, GRANTOR, MANAGEMENT_CONTROL_PERSON, BENEFICIARY Decimal number representing the percent ownership the identity has in the company-- e.g. 5 represents 5% ownership.
PENDING, ERROR, APPROVED, DENIED, DISABLED Institution member ID. Note: This field is auto-generated. Specifying an ID when creating an institution member is a client error.
The time at which the identity is created at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
The time at which the identity is updated at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
Show child attributes
Show child attributes
The TIN verification status for the associated tax_payer_id.
TIN_VERIFICATION_PENDING, TIN_VERIFICATION_ERROR, TIN_VERIFICATION_VALID Show child attributes
Show child attributes
A list of alternate names or aliases associated with the Identity.
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 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 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 INHERITANCE, INVESTMENT_GAINS, BUSINESS_OWNERSHIP_DIVIDENDS, EMPLOYMENT_INCOME, REAL_ESTATE, OTHER_SOURCE_OF_WEALTH SALARY_DISBURSEMENT, INHERITANCE_DISTRIBUTION, INVESTMENT_RETURNS, BUSINESS_DIVIDENDS_PROFITS, PROPERTY_SALE, LOAN_DISBURSEMENT, SAVINGS_ACCOUNT_WITHDRAWAL, GOVERNMENT_BENEFITS INVESTMENT_TRADING, SAVINGS, STABLECOIN_PURCHASE_REDEMPTION CONTRACTUAL, FULL_TIME, PART_TIME, RETIRED, SELF_EMPLOYED, STUDENT, UNEMPLOYED 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 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 Whether or not the institution tied to the Identity has an underlying trust structure.
Whether or not the institution tied to the Identity has nominee shareholders.
true or false indicating whether or not the company is listed on a public stock exchange.
BUSINESS_LOANS_FINANCING, SALARY_SAVINGS, INVESTMENT_GAINS, INHERITANCE, REAL_ESTATE_INCOME, NON_PROFIT_SOURCES, OTHER_BUSINESS_INCOME Regions where the customer base is located.
US_CANADA, MEXICO_CENTRAL_AMERICA, SOUTH_AMERICA, EUROPE, ASIA, AFRICA, OCEANIA True if the identity is a merchant.
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.
Was this page helpful?