# Paxos Documentation

## Docs

- [Build with Paxos](https://paxos-0ac97319-jg-test-1.mintlify.site/welcome.md): Learn how to get started with the Paxos API and Platform.
- [➊ Create Developer Account](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/account.md): Sign Up for access to the Sandbox environment.
- [➋ Configure API Credentials](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/credentials.md): API credentials using Client ID and Secret. Set allowed scopes to access specific API endpoints.
- [➌ Authenticate](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/authenticate.md): Generate an authentication token.
- [➍ Make First API Request](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/request.md): Use the access token to retrieve a list of Profiles.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/index.md): Onboard users directly to the Paxos Platform to accelerate speed to market and outsource your compliance needs.
- [Onboarding a Person for Crypto Brokerage](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/person-crypto-brokerage.md): Create an Identity, Account and Profile to provide Buy, Hold and Sell Crypto Brokerage for Users
- [Onboarding an Institution for Crypto Brokerage](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/institution-crypto-brokerage.md): Create an Institution Identity, Account and Profile to provide Buy, Hold and Sell Crypto Brokerage for Institutions
- [Enhanced Due Diligence](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/edd.md): Manage the enhanced due diligence of an Identity on the Paxos Platform.
- [Periodic KYC Refresh](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/kyc-refresh.md): Manage the periodic KYC refresh of an Identity on the Paxos Platform in an automated, compliant way.
- [Statuses](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/statuses.md): Learn more about Identity statuses and sub-statuses
- [Required Details](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/required-details.md): Learn more about what details are required when creating an Identity
- [Institution Types and Members](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/identity/institution-types.md): Learn about institution types, member roles, and requirements
- [Mint](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/mint.md): Deposit USD. Convert or convert-and-transfer in one API call.
- [Convert](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/convert.md): Implement guaranteed 1:1 conversions between USD and Paxos-issued stablecoins.
- [Redeem](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/redeem.md): Deposit stablecoin and convert to USD in one API call. Transfer USD to your bank.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/fiat-transfers/index.md): Move USD on and off the Paxos Platform via wire transfer or CUBIX.
- [Fiat Transfers Quickstart](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/fiat-transfers/quickstart.md): Set up fiat funding and withdraw flows in the Sandbox environment.
- [Statuses](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/fiat-transfers/statuses.md): Learn more about Fiat Transfers statuses.
- [Fiat Transfers FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/fiat-transfers/fiat-transfers-faq.md): Get answers to common questions about the Fiat Transfers API.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/payments/index.md): Accept stablecoin pay-ins with real-time settlement. Issue on-chain refunds.
- [Stablecoin Pay-ins Quickstart](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/payments/quickstart.md): Accept stablecoin pay-ins with real-time settlement. Issue on-chain refunds.
- [Connect to the WebSocket Stablecoin Price Feed](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/payments/websocket.md): Open a WebSocket connection to the Sandbox USDCUSD feed.
- [Statuses](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/payments/status.md): Learn more about payment statuses.
- [Payments FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/payments/faq.md): Get answers to common questions about payments.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/settlements/index.md): Propose, approve and manage two-way atomic transfers.
- [Quickstart](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/settlements/quickstart.md): Set up and complete the settlement workflow in the Sandbox environment.
- [Statuses](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/settlements/status.md): Learn more about settlement statuses.
- [Notifications](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/settlements/notification.md): Understand how settlement notifications work.
- [FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/settlements/faq.md): Get answers to common questions about the Settlements API.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/index.md): Add crypto to your application using REST, FIX and WebSocket APIs.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/quotes/index.md): Held Rate Quotes (HRQ)
- [HRQ Quickstart](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/quotes/quickstart.md): Learn about Paxos's HRQ product and how to submit a quote in less than five minutes.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/fix/index.md): Leverage the FIX protocol for crypto trading.
- [FIX Certification](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/fix/certify.md): Test and verify the FIX implementation in Sandbox before going to Production.
- [FIX Best Practices](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/fix/best-practices.md): Learn about connection management, sequence number management and testing.
- [Connect to the WebSocket Market Data Feed](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/websocket.md): Open a WebSocket connection to the Sandbox BTC Market Data feed.
- [Orders, Precision and Rounding](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/orders-precision-rounding.md): Learn about tick size, precision, rounding and other recommendations.
- [Commissions and Rebates FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/commissions-rebates.md): Get answers to common questions about commissions and rebates.
- [Choosing a Ledgering Strategy](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/ledger-type.md): Understand your options for ledgering fiat and cryptocurrency with Paxos.
- [Orders & Quotes FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/crypto-brokerage/orders-vs-hrq.md): Get answers to common questions about Orders & Quotes.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/webhooks/index.md): Webhooks provide a way for notifications to be delivered to an external web server whenever certain events occur.
- [Get Started with Webhooks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/webhooks/quickstart.md): Create and register a webhook consumer to start receiving events.
- [Retries and Limits](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/webhooks/retries-and-limits.md): Learn about webhook delivery retries, retry policies, and rate limits for Paxos webhooks.
- [Webhooks FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/webhooks/faq.md): Get answers to common questions about webhooks.
- [Assets and Blockchains](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/blockchains.md): Learn more about supported assets, stablecoins and blockchains.
- [Request Signing](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/request-signing.md): Use JWS to add an additional layer of security to every request.
- [Rate Limits](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/rate-limits.md): Review REST, WebSocket and FIX limits.
- [Reports](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/reports.md): View monthly balances and download daily balance and transaction reconciliation reports.
- [Sandbox](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/sandbox.md): Use the Sandbox environment to mock flows, execute transfers and test integrations.
- [Paxos API FAQ](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/faq.md): Get answers to commonly asked questions.
- [API Breaking Change Policy](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/breaking-change/policy.md): Learn about what qualifies as a breaking change and the what happens when one is necessary.
- [Migrate from v1 to v2 API](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/developer/api-migrate.md): Learn how to migrate your REST integrations.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/index.md): Securely deposit, convert, transfer and custody assets with Paxos.
- [Migrate to the Dashboard](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/migrate-to-dashboard.md): Switch to the Dashboard and access new features and improved workflows.
- [Transactions](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/transactions.md): Monitor Dashboard & API driven Paxos transactions and balances.
- [Saved Instructions](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/instructions.md): View and manage instructions for depositing fiat and other assets onto the Paxos platform.
- [Addresses](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/addresses.md): View and manage addresses for transferring crypto off the Paxos platform.
- [Fiat Accounts](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/fiat.md): View and manage banking information to deposit and withdrawal USD.
- [Organization, Entities and Profiles](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/organization.md): Learn more about the multi-entity experience.
- [Roles and Responsibilities](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/roles.md): Learn more about the default roles for your Entity.
- [Sign In](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/signin.md): Access the Dashboard using a passkey or SSO.
- [Sign Up](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/account.md): Create a business account to get started with the Paxos platform.
- [Onboard to Paxos](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/onboard.md): Learn more about the information required to start using the Paxos process.
- [Deposit](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/deposit.md): Send cash or crypto to the Paxos platform.
- [Convert](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/convert.md): Implement guaranteed 1:1 conversions between USD and Paxos-supported stablecoins.
- [Transfer](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/transfer.md): Move fiat or crypto off the Paxos platform or between Profiles.
- [Mint](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/mint.md): Convert USD to Paxos-issued stablecoins and receive them in an external wallet.
- [Redeem](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/redeem.md): Deposit stablecoin and convert to USD. Transfer USD to your bank.
- [Review Entity Settings](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/admin/entity.md): Get the Entity details and limits.
- [Manage Team](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/admin/team.md): Manage user access and roles within your Entity.
- [Configure API Credentials](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/admin/api.md): Create and update an OAuth2 client.
- [Reports](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/admin/reports.md): View monthly balances and download daily balance and transaction reconciliation reports.
- [Travel Rule Compliance](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/travel-rule.md): Learn more about Travel Rule requirements and the blockchain.
- [Approvals](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/admin/approvals.md): Use Approvals to increase security and prevent mistakes on sensitive actions.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/rewards/overview.md): Manage USDG rewards via the Paxos Dashboard.
- [Monitor Addresses](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/rewards/monitor-addresses.md): Add your first monitoring address.
- [Manage Payouts](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/rewards/manage-payouts.md): Set or update a payout address.
- [Timeline and Disputes](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/rewards/timeline-and-disputes.md): Monthly Rewards Timeline.
- [Passkeys](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/dashboard/passkeys.md): Learn more about using passkeys with the Paxos Dashboard.
- [Stablecoins Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/index.md): Use Paxos-issued stablecoins for payments, money movement and more.
- [Integrate with PYUSD on Ethereum](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/integrate-pyusd.md): The steps to integrate PYUSD on your platform are similar to executing smart contract functions for other ERC20 tokens.
- [PYUSD Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/pyusd/index.md): Use PayPal USD as the payments layer to build new services and products on public blockchains.
- [PYUSD on Main Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/pyusd/mainnet.md): Get the PYUSD mainnet addresses.
- [PYUSD on Test Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/pyusd/testnet.md): Get the PYUSD testnet addresses.
- [USDG Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdg/index.md): Use Global Dollar for payments, settlements, treasury and more.
- [Getting Started with USDG (Global Dollar)](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdg/quickstart.md): How to Access USDG.
- [USDG on Main Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdg/mainnet.md): Get the USDG token addresses.
- [USDG on Test Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdg/testnet.md): Get the USDG token addresses.
- [USDP Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdp/index.md): Learn more about the Fully backed, legally protected, always available Pax Dollar.
- [USDP on Main Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdp/mainnet.md): Get the USDP mainnet addresses.
- [USDP on Test Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdp/testnet.md): Get the USDP testnet addresses.
- [USDL Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdl/index.md): Use Lift Dollar for payments, settlements and treasury while earning on-chain yield.
- [USDL on Main Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdl/mainnet.md): Get the USDL token addresses.
- [USDL on Test Networks](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/usdl/testnet.md): Get the USDL token addresses.
- [BUSD](https://paxos-0ac97319-jg-test-1.mintlify.site/guides/stablecoin/busd.md): Redeem or convert BUSD on the Paxos platform.
- [Paxos API](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/introduction.md): Welcome to Paxos APIs. At Paxos, our mission is to enable the movement of any asset, any time, in a trustworthy way.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/transfers/overview.md): Each deposit to and withdrawal from a Paxos account is a Transfer.
- [List Transfers](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/transfers/list-transfers.md): List all transfers, optionally filtering and paging the results.
- [Get Transfer](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/transfers/get-transfer.md): Get a single transfer by ID.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/overview.md): The Fiat Transfers API allows clients to deposit and withdraw fiat via Wire (Fedwire and SWIFT) and CUBIX networks.
- [List Fiat Accounts](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/list-fiat-accounts.md): List all Fiat Accounts, optionally filtering and paging the results. The response includes an abbreviated `FiatAccount` object:
- [Create Fiat Account](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/create-fiat-account.md): Create an account to initiate a fiat withdrawal.
- [Get Fiat Account](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/get-fiat-account.md): Get a single Fiat Account by ID.
- [Update Fiat Account](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/update-fiat-account.md): Change an existing value or add a new value on one or more fields for the given Fiat Account and return the modified Fiat Account in `PENDING` status. Update fields in **either** `fiat_account_owner.person_details` or `fiat_account_owner.institution_details`. Attempts to convert the `fiat_account_ow…
- [Delete Fiat Account](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/delete-fiat-account.md): Delete a Fiat Account. Once a Fiat Account is deleted, transfers cannot be initiated to it.
- [List Fiat Deposit Instructions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/list-fiat-deposit-instructions.md): Return the associated Fiat Deposit Instructions matching the search criteria for the current Account. The paginated results default to the maximum limit of 1,000 Fiat Deposit instructions, unless otherwise specified with the `limit` parameter. Every paginated response contains a `next_page` field un…
- [Create Fiat Deposit Instructions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/create-fiat-deposit-instructions.md): Create instructions for depositing fiat.
- [Get Fiat Deposit Instructions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/get-fiat-deposit-instructions.md): Get instructions for depositing fiat using a Paxos Fiat Deposit Instructions ID. The Fiat Deposit Instructions ID (`id`) is provided in the response of the [Create Fiat Deposit Instructions](#operation/CreateFiatDepositInstructions).
- [Create Fiat Withdrawal](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fiat-transfers/create-fiat-withdrawal.md): Withdraw fiat to the given destination.
- [List Deposit Addresses](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/deposit-addresses/list-deposit-addresses.md): List all deposit addresses, optionally filtering and paging the results.
- [Create Deposit Address](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/deposit-addresses/create-deposit-address.md): Create a deposit address on a blockchain network for depositing to a profile.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/crypto-deposits/overview.md): For Paxos Global PTE Ltd users, update or reject a crypto deposit that does not contain the required travel rule information.
- [Update Crypto Deposit](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/crypto-deposits/update-crypto-deposit.md): Crypto deposits that do not meet the minimum travel rule requirements are blocked. To update a crypto deposit, provide the required travel rule information about the originator address.
- [Reject Crypto Deposit](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/crypto-deposits/reject-crypto-deposit.md): Reject a crypto deposit which is waiting for required travel rule information about the originator address. If the rejected deposit has any status other than `NEEDS_INFO`, the request will return an error. Only the creator of the crypto deposit can reject it.
- [Create Crypto Withdrawal](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/crypto-withdrawals/create-crypto-withdrawal.md): Withdraw a cryptocurrency asset to a specified destination address.
- [Create Crypto Withdrawal Fee](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/fees/create-crypto-withdrawal-fee.md): Get a guaranteed fee for the given currency, valid for a period of time. Specify exactly one of `amount` or `total`, otherwise an error is returned.
- [Create Internal Transfer](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/internal-transfers/create-internal-transfer.md): Transfer assets between two profiles belonging to the same customer.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/paxos-transfers/overview.md): Move assets between two Entities belonging to the same Organization or to a different Organization on the Paxos platform.
- [Create Paxos Transfer](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/paxos-transfers/create-paxos-transfer.md): Transfer assets between two Profiles belonging to different [Entities](https://docs.paxos.com/dashboard/organization#entity).
- [List Transfer Limits](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/limits/list-transfer-limits.md): List all limits that apply to the given transaction type.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity/overview.md): An Identity represents a person or institution who is able to take actions on the Paxos Platform.
- [List Identities](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity/list-identities.md): 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`
- [Create Identity](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity/create-identity.md): Creates a new Person or Institution Identity on the Paxos Platform.
- [Get Identity](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity/get-identity.md): Get an Identity by its (identity) id. You can only see identities created by you.
- [Update Identity](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity/update-identity.md): Updates an Identity, this action performs a delta of what is submitted in the update and the existing identity. - Updating details (`person_details` or `institution_details`) might lead to the identity being re-verified (e.g. re-screening name changes), which could impact the identity's ability to t…
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/institution-members/overview.md): Institution Members allow you to associate persons with an institution on our Platform.
- [Add Institution Members](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/institution-members/add-institution-members.md): Add one or more institution members to a given institution.
- [Remove Institution Member](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/institution-members/remove-institution-member.md): Removes an institution member from an institution.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/accounts/overview.md): Accounts connect Identities (persons or institutions) to Profiles (asset balances).
- [List Accounts](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/accounts/list-accounts.md): List accounts with pagination. Every response will contain a `next_page` field, as long as the end of the list has not been reached. Pass this value into the `page_cursor` field of the next request to retrieve the next page of results.
- [Create Account](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/accounts/create-account.md): Create an account for a given identity, via the `identity_id` field. This identity is the primary owner of the account for all tax-related purposes.
- [Get identityaccounts](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/accounts/get-identityaccounts.md)
- [Update Account](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/accounts/update-account.md): This enables you to update an existing account with new information. Please refer to the following table for fields that can be updated via this endpoint.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/account-members/overview.md): Account Members allow you to associate an Identity with an Account on our Platform.
- [Add Account Members](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/account-members/add-account-members.md): Add one or more account members to a given account.
- [Remove Account Member](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/account-members/remove-account-member.md): Removes an account member from an account.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity-documents/overview.md): The Identity Documents API allows clients to send documents to Paxos to validate identities during the KYC process.
- [List Identity Documents](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity-documents/list-identity-documents.md): This endpoint enables you to get a list of all documents associated with an identity.
- [Document Upload](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/identity-documents/document-upload.md): This endpoint enables you to receive a URL to upload a document to Paxos for identity verification or enhanced due diligence purposes. When uploading a document you must specify the document type. You will receive a URL where you can upload the document using a POST request.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/overview.md): Profiles hold asset balances, and every Paxos transaction is on a particular profile.
- [List Profiles](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/list-profiles.md): Return the associated Profiles for the current Account. The paginated results default to the maximum limit of 1,000 Profiles, unless otherwise specified with the `limit` parameter. Every paginated response contains a `next_page` field until the last page is reached. Pass the `next_page` value into t…
- [Create Profile](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/create-profile.md): Create a new profile for this account. Profiles created using this endpoint always have a type of `NORMAL`.
- [Get Profile](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/get-profile.md): Read a single profile by its UUID, or read the default profile using the alias "default".
- [Update Profile](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/update-profile.md): Change the `nickname` label for the given `profile_id` (Profile).
- [Deactivate Profile](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/deactivate-profile.md): Deactivate the given `profile_id`. The default profile cannot be deactivated. Deactivated profiles won't be visible for deposits. Profiles with more than zero balances cannot be deactivated. If a deactivated profile has a non-zero balance it will be reactivated.
- [List Profile Balances](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/list-profile-balances.md): Retrieve the Profile’s available and trading balances. Use query parameters to retrieve a defined set of assets. Omit query parameters to retrieve all asset balances.
- [Get Profile Balance](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/profiles/get-profile-balance.md): Get the balance of `asset` in a profile.
- [Create Sandbox Deposit](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/sandbox-deposits/create-sandbox-deposit.md): Create a test deposit to fund a profile in the sandbox environment.
- [Sandbox Set Identity Status](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/sandbox-identity/sandbox-set-identity-status.md): Set the various statuses for the given Identity. To enable the Person Identity to transact, set both `id_verification_status` and `sanctions_verification_status` to `"APPROVED"`. To enable the Institution to transact, set both `sanctions_verification_status` to `"APPROVED"`. This endpoint also allow…
- [Initiate Sandbox Fiat Deposit](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/sandbox-fiat-transfers/initiate-sandbox-fiat-deposit.md): Initiate a test fiat deposit in the sandbox environment.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/settlement/overview.md): Use the Settlements API to facilitate simultaneous exchange of pre-funded assets.
- [List Transactions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/settlement/list-transactions.md): This endpoint enables you to fetch a list of Settlement Transactions that you have created (own the `source_profile_id`) or have been alleged against you (own the `target_profile_id`). You can use query parameters to filter the results returned by `statuses`, `source_profile_id` and `target_profile_…
- [Create Transaction](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/settlement/create-transaction.md): Creates a new bilateral Settlement Transaction with one or more legs. The customer must own the `source_profile_id` specified in the transaction.
- [Get Transaction](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/settlement/get-transaction.md): Get a Settlement Transaction by its (transaction) id, you must have created the transaction (own the `source_profile_id`) or have had the transaction alleged against you (own the `target_profile_id`).
- [Cancel Transaction](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/settlement/cancel-transaction.md): Cancels the Settlement Transaction, this action can only be done by the customer owning the source profile (`source_profile_id`). The transaction must be in a `"PENDING"` status for this to take effect, you cannot cancel a transaction which is `"AFFIRMED"`.
- [Affirm Transaction](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/settlement/affirm-transaction.md): Affirms the Settlement Transaction for settlement, the transaction is now eligible for settlement once the current time is between the provided `settlement_window_start` and `settlement_window_end`. This action can only be done by the customer owning the target profile (`target_profile_id`). The tra…
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/stablecoin-conversion/overview.md): Convert between fiat and stablecoin using the Stablecoin Conversion API.
- [List Stablecoin Conversions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/stablecoin-conversion/list-stablecoin-conversions.md): List all conversions, optionally filtering and paging the results.
- [Create Stablecoin Conversion](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/stablecoin-conversion/create-stablecoin-conversion.md): Create a Conversion request to exchange assets 1:1.
- [Get Stablecoin Conversion](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/stablecoin-conversion/get-stablecoin-conversion.md): Retrieve a single conversion using the transaction `id` from the [Create Stablecoin Conversion](#operation/CreateStablecoinConversion) response.
- [Cancel Stablecoin Conversion](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/stablecoin-conversion/cancel-stablecoin-conversion.md): Cancel a single conversion using the `id` from the [Create Stablecoin Conversion](#operation/CreateStablecoinConversion) response.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/tax-forms/overview.md): All tax forms are associated to a single account_id.
- [List Tax Forms](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/tax-forms/list-tax-forms.md): Used for bulk file transfer use cases. List tax forms for given account ids and tax year. The most recent revision number will be returned (revisions increment up; highest value revision for a specific account, tax year, and form type pairing is the most recent). Tax Form URL links will expire after…
- [List Tax Form Revisions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/tax-forms/list-tax-form-revisions.md): Used for more granular file retrieval for specific accounts that require updated tax forms. Lists all versions of a tax form for single account and tax year. Revisions will increment up as new tax forms are issued for the same account, tax year, and form type pairing. The highest value revision is t…
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/market-data/overview.md): Market data provides various parameters of the order book and historical order data.
- [List Markets](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/market-data/list-markets.md): Retrieves the set of current available markets for trading with details.
- [Get Order Book](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/market-data/get-order-book.md): Retrieves the full list of bids and asks of the order book at individual price levels with resting quantities per level.
- [List Recent Executions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/market-data/list-recent-executions.md): Retrieves the list of 2000 most recent executions by all users to occur in the order book.
- [Get Ticker](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/market-data/get-ticker.md): Retrieves order book statistics of the exchange over the last 24 hours and from midnight UTC until current time.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/orders/overview.md): Order management for market, limit, and post-only orders.
- [List Orders](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/orders/list-orders.md): Retrieves full details of orders associated with a Profile ID, with optional filters.
- [Create Order](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/orders/create-order.md): For limit orders, create an order for buying or selling an asset:
- [Get Order](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/orders/get-order.md): Retrieves the current state of an order. - Historical data prior to May 16, 2022 is unavailable.
- [Cancel Order](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/orders/cancel-order.md): Submits a cancellation request. A response indicates that the request has been acknowledged and provides no guarantee the order has been cancelled.
- [List Executions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/orders/list-executions.md): Retrieves full details of underlying executions with optional filters. Notes: - This endpoint returns a maximum of 1000 items per page. - Filtering options are `account_id`, `profile_id` or neither (all executions).
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/quotes/overview.md): Quotes are 'held rates' offered by Paxos to buy or sell assets at a specific price within a period of time.
- [List Quotes](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/quotes/list-quotes.md): List quotes for buying or selling assets. By default, the list will include the latest available quotes for both buying and selling all supported assets.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/quote-executions/overview.md): Quote Executions buy or sell assets using a Quote obtained from the Quotes flow.
- [List Quote Executions](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/quote-executions/list-quote-executions.md): List quote executions within a particular profile.
- [Create Quote Execution](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/quote-executions/create-quote-execution.md): Execute on a quote for buying or selling an asset.
- [Get Quote Execution](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/quote-executions/get-quote-execution.md): Get an existing quote execution for buying or selling an asset.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/pricing/overview.md): Pricing provides historical data related to charting of asset prices.
- [List Prices](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/pricing/list-prices.md): Retrieve current prices, as well as 24 hour prior (yesterday) prices, for the specified markets. Any single market that failed to be retrieved is excluded from the response.
- [List Tickers](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/pricing/list-tickers.md): Retrieves order book statistics of the exchange for all markets over the last 24 hours and from midnight UTC until current time.
- [List Historical Prices](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/pricing/list-historical-prices.md): Retrieves a set of average prices at a certain increment of time for the requested market. This endpoint is suitable for retrieving historical average price trends where price precision, execution, and other detailed information is not required. To control the count, use either  `increment` or `max_…
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/monitoring-addresses/overview.md): A Monitoring Address is a blockchain address that Paxos monitors daily for eligible stablecoin activity.
- [List Monitoring Address](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/monitoring-addresses/list-monitoring-address.md): Retrieve a list of monitoring address
- [Create Monitoring Address](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/monitoring-addresses/create-monitoring-address.md): Adds an address to be monitored for rewards distribution
- [Get Monitoring Address](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/monitoring-addresses/get-monitoring-address.md): Retrieves a monitoring address by id
- [Update Monitoring Address](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/monitoring-addresses/update-monitoring-address.md): Updates a monitored address name
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/statements/overview.md): A Statement summarizes all eligible stablecoin rewards for a given organization over a fixed time period.
- [List Statements](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/statements/list-statements.md): List statements based on the provided filters
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/payments/overview.md): Payments represent actual transfers of rewards to the payout address associated with a given statement.
- [List Payments](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/payments/list-payments.md): List payments based on the provided filters
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/events/overview.md): Retrieve events from your Paxos account
- [List Events](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/events/list-events.md): This endpoint enables you to fetch a list of events that have been created by the system. You can use query parameters to filter the results by the `created_at` time using `created_at.lt`, `created_at.gt`, etc. and you can `limit` the number of events returned.
- [Get Event](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/events/get-event.md): Get an Event by its (event) id, the event must have been created by the system and you must be the owner of the the event, you can get an event id by either listing events or via a webhook integration.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/api-credentials/overview.md): The API Credentials API allows clients to create and manage API credentials for accessing Paxos services.
- [List API Credentials](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/endpoints/api-credentials/list-api-credentials.md): List all API credentials that have been created.
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/overview.md): Event-driven connectivity for payments and trading.
- [Execution Data](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/execution-data.md)
- [Execution Data (Market)](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/execution-data-market.md)
- [Market Data](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/market-data.md)
- [Market Data (Market)](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/market-data-market.md)
- [Market Data (Stablecoin)](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/market-data-stablecoin.md)
- [Market Data (Stablecoin Market)](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websockets/market-data-stablecoin-market.md)
- [identity.documents_required](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-documents-required.md): Webhook triggered when additional documents are required for identity verification
- [identity.approved](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-approved.md): Webhook triggered when an identity verification is approved
- [identity.denied](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-denied.md): Webhook triggered when an identity verification is denied
- [identity.disabled](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-disabled.md): Webhook triggered when an identity is disabled
- [identity.kyc_refresh.started](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-kyc-refresh-started.md): Webhook triggered when a KYC refresh process is initiated
- [identity.kyc_refresh.completed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-kyc-refresh-completed.md): Webhook triggered when a KYC refresh process is successfully completed
- [identity.kyc_refresh.expired](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/identity-kyc-refresh-expired.md): Webhook triggered when a KYC refresh process expires without completion
- [identity_documents_required](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/events/identity-documents-required-object.md): Event object returned for identity.documents_required events
- [identity_summary_status_change](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/events/identity-status-change-object.md): Event object returned for identity status change events
- [identity_kyc_refresh](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/events/identity-kyc-refresh-object.md): Event object returned for KYC refresh events
- [transfer.crypto_deposit.pending](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-crypto-deposit-pending.md): Webhook triggered when a crypto deposit is detected on-chain and is pending confirmation
- [transfer.crypto_deposit.completed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-crypto-deposit-completed.md): Webhook triggered when a crypto deposit is completed and funds are available
- [transfer.crypto_deposit.failed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-crypto-deposit-failed.md): Webhook triggered when a crypto deposit has failed or been cancelled
- [transfer.crypto_withdrawal.pending](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-crypto-withdrawal-pending.md): Webhook triggered when a crypto withdrawal has been initiated and is pending
- [transfer.crypto_withdrawal.completed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-crypto-withdrawal-completed.md): Webhook triggered when a crypto withdrawal is completed and sent to destination
- [transfer.crypto_withdrawal.failed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-crypto-withdrawal-failed.md): Webhook triggered when a crypto withdrawal has failed or been cancelled
- [transfer.act_deposit.pending](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-act-deposit-pending.md): Webhook triggered when a fiat deposit via DBS has been initiated and is pending
- [transfer.act_deposit.completed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-act-deposit-completed.md): Webhook triggered when a fiat deposit via DBS is completed and funds are available
- [transfer.act_deposit.failed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-act-deposit-failed.md): Webhook triggered when a fiat deposit via DBS has failed or been cancelled
- [transfer.act_withdrawal.pending](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-act-withdrawal-pending.md): Webhook triggered when a fiat withdrawal via DBS has been initiated and is pending
- [transfer.act_withdrawal.completed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-act-withdrawal-completed.md): Webhook triggered when a fiat withdrawal via DBS is completed and sent to destination
- [transfer.act_withdrawal.failed](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks/transfer-act-withdrawal-failed.md): Webhook triggered when a fiat withdrawal via DBS has failed or been cancelled
- [transfer_status_change](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/events/transfer-status-change-object.md): Event object returned for transfer status change events
- [Overview](https://paxos-0ac97319-jg-test-1.mintlify.site/cookbook/overview.md): Ready-to-use recipes for common Paxos integration patterns
- [Third Party Brokerage Enrollment](https://paxos-0ac97319-jg-test-1.mintlify.site/cookbook/third-party-brokerage-enrollment.md): Step-by-step recipe to create a Person Identity, Account, and Profile for third-party crypto brokerage services

## OpenAPI Specs

- [paxos-v2.openapi](https://developer.paxos.com/docs/paxos-v2.openapi.json)
- [webhooks-openapi](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/webhooks-openapi.json)
- [paxos-v2-preview-orchestration.openapi](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/preview/paxos-v2-preview-orchestration.openapi.json)

## AsyncAPI Specs

- [websocket-asyncapi](https://paxos-0ac97319-jg-test-1.mintlify.site/api-reference/websocket-asyncapi.json)

## Optional

- [Changelog](https://docs.paxos.com/changelog)
- [Status](https://status.paxos.com/)
- [Blog](https://www.paxos.com/blog)
- [Faucet](https://faucet.paxos.com/)
- [Regulation and Transparency](https://www.paxos.com/regulation-and-transparency/)