# Paxos Documentation ## Docs - [Add Account Members](https://docs.sandbox.paxos.com/api-reference/endpoints/account-members/add-account-members.md): Add one or more account members to a given account. The account members added by this API do not affect existing account members. For example, if an account has two members, and one member is added using this API, then the account will end up with three members. For more information on properties of account members, see [Account Members](#account-members). - [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/account-members/overview.md): Account Members allow you to associate an Identity with an Account on our Platform. - [Remove Account Member](https://docs.sandbox.paxos.com/api-reference/endpoints/account-members/remove-account-member.md): Removes an account member from an account. - [Create Account](https://docs.sandbox.paxos.com/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. To track user balances using Paxos [Profiles](#tag/Profiles), use `create_profile=true` when creating the account. Once an account has been created, it is not possible to associate it with a [Profile](#tag/Profiles). ### Account Members In addition to the primary owner, other identities may be associated with the account, by using `members`. The identity on the account is treated as a BENEFICIAL_OWNER. To add a financial advisor to an account, add a member with the FINANCIAL_ADVISOR role. #### Example This example request creates a joint account for John and Jane Doe. John has identity_id=82c338f4-3cb7-4d9b-be2a-4b077c82ee3a, and Jane has identity_id=0f5d8475-33f3-4ebd-88a0-66dedc2581c1. John is the primary owner of the account for tax-purposes, but Jane is a full beneficial owner. Additionally, this account has an associated financial advisor with identity_id=0d26f878-298e-4d47-81be-cdf4e982a3d3.
{
"account": {
"identity_id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER"]
}, {
"identity_id": "0d26f878-298e-4d47-81be-cdf4e982a3d3",
"roles": ["FINANCIAL_ADVISOR"]
}]
}
}
### Fields
Any fields not listed are forbidden in this request.
Field | Notes
---|---
identity_id | Required
description | Optional
metadata | Optional
ref_id | Optional
members | Optional
- [Get account](https://docs.sandbox.paxos.com/api-reference/endpoints/accounts/get-identityaccounts.md)
- [List Accounts](https://docs.sandbox.paxos.com/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.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/accounts/overview.md): Accounts connect Identities (persons or institutions) to Profiles (asset balances).
- [Update Account](https://docs.sandbox.paxos.com/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.
Field | Notes
---|---
account.id | Required
account.description | Optional
account.ref_id | Optional
account.metadata | Optional. This will overwrite any existing metadata added to the account.
account.members | Optional. The only roles that can be added/removed are `FINANCIAL_ADVISOR` or `AUTHORIZED_USER.` You must always specify the full members object as we do not currently support differential member updates.
set_user_disabled | Optional. Setting this to `true` will disable the account, limiting its ability to be used within the Paxos platform.
#### Example Requests
#### Disabling an account
{
"set_user_disabled": true,
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"description": "Account Description",
"ref_id": "82c338f4-3cb7",
}
}
### Adding an account member
To retain the existing account members and add a new account member, the `members` field must contain the existing account members and the
new member. The below example adds an `AUTHORIZED_USER` to the account.
In order to add account members while leaving existing account members unaffected, clients
should use the [Add Account Members](#operation/AddAccountMembers) API.
{
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER"]
}, {
"identity_id": "0d26f878-298e-4d47-81be-cdf4e982a3d3",
"roles": ["FINANCIAL_ADVISOR"]
}, {
"identity_id": "012k23eb-298e-4d47-81be-cdf4e982a3d3",
"roles": ["AUTHORIZED_USER"]
}]
}
}
### Removing an account member
To remove an existing account member and retain other needed members, the `members` field must contain
the existing account members without the account member you'd like to remove. The below example removes an `AUTHORIZED_USER` from the account.
Note, this API requires the `members` array to have at least one element. In order to delete all members
from an account, clients should use the [Delete Account Member](#operation/DeleteAccountMember) API.
{
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER"]
}]
}
}
### Updating an account members' roles
To update an account members' roles, the `members` field must contain all the existing members with their roles along
with the additional role that you'd like to add or remove. The below example adds the `FINANCIAL_ADVISOR` role to an member that is already a `BENEFICIAL_OWNER`.
{
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER", "FINANCIAL_ADVISOR"]
}]
}
}
- [List API Credentials](https://docs.sandbox.paxos.com/api-reference/endpoints/api-credentials/list-api-credentials.md): List all API credentials that have been created.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/api-credentials/overview.md): The API Credentials API allows clients to create and manage API credentials for accessing Paxos services.
- [Overview](https://docs.sandbox.paxos.com/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.
- [Reject Crypto Deposit](https://docs.sandbox.paxos.com/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.
- [Update Crypto Deposit](https://docs.sandbox.paxos.com/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.
- [Create Crypto Withdrawal](https://docs.sandbox.paxos.com/api-reference/endpoints/crypto-withdrawals/create-crypto-withdrawal.md): Withdraw a cryptocurrency asset to a specified destination address.
- [Create Deposit Address](https://docs.sandbox.paxos.com/api-reference/endpoints/deposit-addresses/create-deposit-address.md): Create a deposit address on a blockchain network for depositing to a profile.
- [List Deposit Addresses](https://docs.sandbox.paxos.com/api-reference/endpoints/deposit-addresses/list-deposit-addresses.md): List all deposit addresses, optionally filtering and paging the results.
- [Get Event](https://docs.sandbox.paxos.com/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.
- [List Events](https://docs.sandbox.paxos.com/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.
Using `created_at` and `limit` together will allow you to paginate through all events owned by you.
Events returned will always be order in `created_at` ascending order.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/events/overview.md): Retrieve events from your Paxos account
- [Create Crypto Withdrawal Fee](https://docs.sandbox.paxos.com/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.
The [Create Crypto Withdrawal](#operation/CreateCryptoWithdrawal) request that uses the guaranteed fee endpoint
must specify an `amount` less than or equal to the guaranteed fee `amount`, otherwise the withdrawal is rejected.
- [Create Fiat Account](https://docs.sandbox.paxos.com/api-reference/endpoints/fiat-transfers/create-fiat-account.md): Create an account to initiate a fiat withdrawal.
For U.S. wires, set `fiat_network_instructions` > `wire` > `routing_details` > `routing_number_type` to `ABA`. For international (SWIFT) wires, set `fiat_network_instructions` > `wire` > `routing_details` > `routing_number_type` to `SWIFT`.
For CUBIX, set `fiat_network_instructions` > `cubix` > `account_id`, and do not specify `routing_number_type`. For CUBIX, the `account_id` is the CUBIX account ID.
- [Create Fiat Deposit Instructions](https://docs.sandbox.paxos.com/api-reference/endpoints/fiat-transfers/create-fiat-deposit-instructions.md): Create instructions for depositing fiat.
- [Create Fiat Withdrawal](https://docs.sandbox.paxos.com/api-reference/endpoints/fiat-transfers/create-fiat-withdrawal.md): Withdraw fiat to the given destination.
- [Delete Fiat Account](https://docs.sandbox.paxos.com/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.
- [Get Fiat Account](https://docs.sandbox.paxos.com/api-reference/endpoints/fiat-transfers/get-fiat-account.md): Get a single Fiat Account by ID.
In the polling workflow, this endpoint can be called to monitor a FiatAccount's status.
The Fiat Account response includes the full account number, beneficiary name and address details.
- [Get Fiat Deposit Instructions](https://docs.sandbox.paxos.com/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).
- [List Fiat Accounts](https://docs.sandbox.paxos.com/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:
- Beneficiary name and address details are excluded.
- Only the last four (**4**) digits of the account number are included.
Use [Get Fiat Account](#operation/GetFiatAccount) to retrieve the complete `FiatAccount` object.
The paginated results default to the maximum limit of 1,000 Fiat Accounts, 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 the `page_cursor` field of the next request to retrieve the next page of results.
- [List Fiat Deposit Instructions](https://docs.sandbox.paxos.com/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 until the last page is reached.
Pass the `next_page` value into the `page_cursor` field of the next request to retrieve the next page of results.
- [Overview](https://docs.sandbox.paxos.com/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.
- [Update Fiat Account](https://docs.sandbox.paxos.com/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_owner` type results in an error.
Empty strings or null values are ignored.
Upon successful response, Paxos initiates an automated review of the requested changes and then either sets the status to `APPROVED` or `REJECTED`.
Occasionally, a manual review may be required.
Use [Get Fiat Account](#operation/GetFiatAccount) to check for status changes.
- [Document Upload](https://docs.sandbox.paxos.com/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.
Requirements:
- Uploaded documents must be less than 100 MB in size
- Supported formats include PDF, JPG, and PNG
For more information on document requirements for enhanced due diligence, see [here](https://docs.paxos.com/identity/edd).
- [List Identity Documents](https://docs.sandbox.paxos.com/api-reference/endpoints/identity-documents/list-identity-documents.md): This endpoint enables you to get a list of all documents associated with an identity.
- [Overview](https://docs.sandbox.paxos.com/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.
- [Create Identity](https://docs.sandbox.paxos.com/api-reference/endpoints/identity/create-identity.md): Creates a new Person or Institution Identity on the Paxos Platform.
A successful response indicates that the identity has been created and is `PENDING` approval. The identity is only
available to use on the Platform once it is `APPROVED`. For a full description of statuses read the [status guide here](https://docs.paxos.com/identity/statuses).
For detailed guidance on which [fields are required](https://docs.paxos.com/identity/required-details) for your integration
or the [lifecycle of an Identity](https://docs.paxos.com/identity/statuses) on the platform, please read the [Identity Developer Guide](https://docs.paxos.com/identity).
- [Get Identity](https://docs.sandbox.paxos.com/api-reference/endpoints/identity/get-identity.md): Get an Identity by its (identity) id. You can only see identities created by you.
You can use the query parameter `include_details` to include identity details (`person_details` or `institution_details`) in
the response and the query parameter `include_institution_members` to include institution members in the response.
- [List Identities](https://docs.sandbox.paxos.com/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`
Note that this endpoint supports pagination and returns a cursor token for fetching next pages.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/identity/overview.md): An Identity represents a person or institution who is able to take actions on the Paxos Platform.
- [Update Identity](https://docs.sandbox.paxos.com/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 transact on the Platform.
- Setting `set_user_disabled` to `true` will make the Identity `DISABLED` (read [more here](https://docs.paxos.com/identity/statuses) on what this means)
- Setting `tax_details` will update all the tax details for the identity
- Setting `last_kyc_refresh_date` indicates this is not an adhoc-update, and instead an update for a [periodic kyc refresh](https://docs.paxos.com/identity/kyc-refresh)
Changing an Institution Identity to a Person and vice-versa is not supported.
- [Add Institution Members](https://docs.sandbox.paxos.com/api-reference/endpoints/institution-members/add-institution-members.md): Add one or more institution members to a given institution.
Adding new members doesn't affect existing members. For example, if an institution has three
members, and adds two members using this API, then the institution would end up with five total members.
For details on the properties that can be specified when creating institution members,
see [Specifying Institution Members and Their Roles](#specifying-institution-members-and-their-roles).
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/institution-members/overview.md): Institution Members allow you to associate persons with an institution on our Platform.
- [Remove Institution Member](https://docs.sandbox.paxos.com/api-reference/endpoints/institution-members/remove-institution-member.md): Removes an institution member from an institution.
- [Create Internal Transfer](https://docs.sandbox.paxos.com/api-reference/endpoints/internal-transfers/create-internal-transfer.md): Transfer assets between two profiles belonging to the same customer.
- [List Transfer Limits](https://docs.sandbox.paxos.com/api-reference/endpoints/limits/list-transfer-limits.md): List all limits that apply to the given transaction type.
- [Get Order Book](https://docs.sandbox.paxos.com/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.
- [Get Ticker](https://docs.sandbox.paxos.com/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.
- [List Markets](https://docs.sandbox.paxos.com/api-reference/endpoints/market-data/list-markets.md): Retrieves the set of current available markets for trading with details.
- [List Recent Executions](https://docs.sandbox.paxos.com/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.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/market-data/overview.md): Market data provides various parameters of the order book and historical order data.
- [Create Monitoring Address](https://docs.sandbox.paxos.com/api-reference/endpoints/monitoring-addresses/create-monitoring-address.md): Adds an address to be monitored for rewards distribution
Currently supporting only `ETHEREUM`, `SOLANA` & `INK` addresses are supported
- [Get Monitoring Address](https://docs.sandbox.paxos.com/api-reference/endpoints/monitoring-addresses/get-monitoring-address.md): Retrieves a monitoring address by id
- [List Monitoring Address](https://docs.sandbox.paxos.com/api-reference/endpoints/monitoring-addresses/list-monitoring-address.md): Retrieve a list of monitoring address
Filter by address, network or both to retrieve a single record
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/monitoring-addresses/overview.md): A Monitoring Address is a blockchain address that Paxos monitors daily for eligible stablecoin activity.
- [Update Monitoring Address](https://docs.sandbox.paxos.com/api-reference/endpoints/monitoring-addresses/update-monitoring-address.md): Updates a monitored address name
- [Cancel Order](https://docs.sandbox.paxos.com/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.
- [Create Order](https://docs.sandbox.paxos.com/api-reference/endpoints/orders/create-order.md): For limit orders, create an order for buying or selling an asset:
- To buy, set `side = BUY` and set `base_amount` to the crypto amount you want to buy.
- To sell, set `side = SELL` and set `base_amount` to the crypto amount you want to sell.
For market orders, create an order for buying or selling an asset:
- To buy, set `side = BUY` and set `quote_amount` to the dollar amount you want to spend.
- To sell, set `side = SELL` and set `base_amount` to the crypto amount you want to sell.
There are five types of orders:
- Limit Orders: Buy or sell at a specified price or better. Execution not guaranteed. Taker orders will be rejected if price deviates 15% from midpoint.
- Post-Only Limit Orders: have the same properties as Limit Orders, but get rejected if they cross the orderbook.
- Market Orders: Operate as Immediate or Cancel (IOC) orders. Price is variable, executes at best available price at time of order.
- Stop Market Orders: Will convert to a market sell order with the specified quantity when the stop price is hit. The stop price does not guarantee that it will be executed at that price. Market conditions (price) might change between the order being triggered and order being executed. Currently only sell stop loss orders are supported.
- Stop Limit Orders: have a Stop Price which when hit, will convert to a limit sell order that will be executed at a specified price (or better)
Maximum notional order size by type:
Order Type | Market | Maximum Notional Value (USD)
---------- | ------- | ----------------------------
Market | all | 500,000
Limit | BTCUSD | 1,500,000
Limit | ETHUSD | 1,500,000
Limit | other | 1,000,000
- [Get Order](https://docs.sandbox.paxos.com/api-reference/endpoints/orders/get-order.md): Retrieves the current state of an order.
- Historical data prior to May 16, 2022 is unavailable.
- [List Executions](https://docs.sandbox.paxos.com/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).
- [List Orders](https://docs.sandbox.paxos.com/api-reference/endpoints/orders/list-orders.md): Retrieves full details of orders associated with a Profile ID, with optional filters.
- Historical data prior to May 16, 2022 is unavailable.
- Pagination Limit has a max of 1000. Pagination Offset is now deprecated and nonfunctional.
- Filtering options are `account_id`, `profile_id` or neither (all orders).
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/orders/overview.md): Order management for market, limit, and post-only orders.
- [Create Paxos Transfer](https://docs.sandbox.paxos.com/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).
- [Overview](https://docs.sandbox.paxos.com/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.
- [List Payments](https://docs.sandbox.paxos.com/api-reference/endpoints/payments/list-payments.md): List payments based on the provided filters
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/payments/overview.md): Payments represent actual transfers of rewards to the payout address associated with a given statement.
- [List Historical Prices](https://docs.sandbox.paxos.com/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_data_points`.
List Historical Prices returns an error when an unexpected value is given, or when `increment` and
`max_data_points` are both given or omitted.
When `range.begin` is omitted, the first data point shows the mid price, the average of the order book best bid
and ask price, or the earliest available date. It is possible to set `range.begin` to a future date without error.
When `range.end` is omitted, the last data point will display current mid price (average of order book best bid
and best ask) at the request timestamp. It is possible to set `range.end` to a future date without error.
When `pagination.limit` is omitted, the pagination limit will default to return the first 100 items.
If the pagination limit is set, the API will return up to the limit in one response. The pagination limit max is 1,000.
Time-series items are returned in chronological (ascending) order. All timestamps are in UTC.
- [List Prices](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/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.
Please note: List Tickers displays pricing from external venues when the itBit exchange is not available.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/pricing/overview.md): Pricing provides historical data related to charting of asset prices.
- [Create Profile](https://docs.sandbox.paxos.com/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`.
- [Deactivate Profile](https://docs.sandbox.paxos.com/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.
- [Get Profile](https://docs.sandbox.paxos.com/api-reference/endpoints/profiles/get-profile.md): Read a single profile by its UUID, or read the default profile using the alias "default".
- [Get Profile Balance](https://docs.sandbox.paxos.com/api-reference/endpoints/profiles/get-profile-balance.md): Get the balance of `asset` in a profile.
- [List Profile Balances](https://docs.sandbox.paxos.com/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.
- [List Profiles](https://docs.sandbox.paxos.com/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 the `page_cursor` field of the next request to retrieve the next page of results.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/profiles/overview.md): Profiles hold asset balances, and every Paxos transaction is on a particular profile.
- [Update Profile](https://docs.sandbox.paxos.com/api-reference/endpoints/profiles/update-profile.md): Change the `nickname` label for the given `profile_id` (Profile).
- [Create Quote Execution](https://docs.sandbox.paxos.com/api-reference/endpoints/quote-executions/create-quote-execution.md): Execute on a quote for buying or selling an asset.
The side, market, and guaranteed price of the execution are specified by the quote
with ID `quote_id`.
The amount to buy or sell must be specified in either fiat or crypto by setting
exactly one of:
- `base_amount` to specify the amount of crypto to buy or sell.
- `quote_amount` to specify the amount of fiat to spend or acquire.
An otherwise-valid request to create a quote execution may fail with the following
types of errors:
- [Expired](https://developer.paxos.com/docs/v2/problems/expired) if the quote
with ID `quote_id` has expired.
- [Insufficient Funds](https://developer.paxos.com/docs/v2/problems/insufficient-funds)
if the profile with ID `profile_id` has insufficient available balance to
fund the execution.
- [Rejected](https://developer.paxos.com/docs/v2/problems/rejected) if extreme
market conditions (e.g. a very large price swing) have invalidated the quote.
- [Already Exists](https://developer.paxos.com/docs/v2/problems/already-exists)
if a Quote Execution with the same `ref_id` has already been created.
- [Get Quote Execution](https://docs.sandbox.paxos.com/api-reference/endpoints/quote-executions/get-quote-execution.md): Get an existing quote execution for buying or selling an asset.
- [List Quote Executions](https://docs.sandbox.paxos.com/api-reference/endpoints/quote-executions/list-quote-executions.md): List quote executions within a particular profile.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/quote-executions/overview.md): Quote Executions buy or sell assets using a Quote obtained from the Quotes flow.
- [List Quotes](https://docs.sandbox.paxos.com/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.
Each quote is valid until `expires_at`, and can be executed on by
calling [Create Quote Execution](#operation/CreateQuoteExecution).
Multiple calls to list quotes in quick succession may return the same quote
values. Paxos currently issues new quotes at most once per second.
- [Overview](https://docs.sandbox.paxos.com/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.
- [Create Sandbox Deposit](https://docs.sandbox.paxos.com/api-reference/endpoints/sandbox-deposits/create-sandbox-deposit.md): Create a test deposit to fund a profile in the sandbox environment.
Always specify `crypto_network` when making a crypto sandbox deposit. Omit the parameter when depositing fiat.
*This functionality is only available in the sandbox environment.*
- [Initiate Sandbox Fiat Deposit](https://docs.sandbox.paxos.com/api-reference/endpoints/sandbox-fiat-transfers/initiate-sandbox-fiat-deposit.md): Initiate a test fiat deposit in the sandbox environment.
The deposit will be processed based on `memo_id` from a previous Fiat Deposit Instructions response.
*This functionality is only available in the sandbox environment.*
- [Sandbox Set Identity Status](https://docs.sandbox.paxos.com/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 allows you to set the statuses for `document_verification_status` and
`additional_screening_status`
- [Affirm Transaction](https://docs.sandbox.paxos.com/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 transaction must be in a `"PENDING"` status for this to take effect.
- [Cancel Transaction](https://docs.sandbox.paxos.com/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"`.
- [Create Transaction](https://docs.sandbox.paxos.com/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.
A successful response indicates the transaction has been accepted and will be in an initial `status` of `"PENDING"`
for settlement, the transaction is only eligible for settlement once the `status` is `"AFFIRMED"` by the
`target_profile_id` and the current time is between the provided `settlement_window_start` and `settlement_window_end`.
Settlement will only be enacted once both `source_profile_id` and `target_profile_id` have sufficient balances to
fulfill all legs specified as settlement is **atomic**.
- [Get Transaction](https://docs.sandbox.paxos.com/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`).
- [List Transactions](https://docs.sandbox.paxos.com/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_id`.
Note that this endpoint supports pagination and returns a cursor token for fetching next pages.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/settlement/overview.md): Use the Settlements API to facilitate simultaneous exchange of pre-funded assets.
- [Cancel Stablecoin Conversion](https://docs.sandbox.paxos.com/api-reference/endpoints/stablecoin-conversion/cancel-stablecoin-conversion.md): Cancel a single conversion using the `id` from the
[Create Stablecoin Conversion](#operation/CreateStablecoinConversion) response.
- [Create Stablecoin Conversion](https://docs.sandbox.paxos.com/api-reference/endpoints/stablecoin-conversion/create-stablecoin-conversion.md): Create a Conversion request to exchange assets 1:1.
A request to create a conversion can fail with one of the following
types of errors:
- [Insufficient Funds](https://developer.paxos.com/docs/v2/problems/insufficient-funds)
if the Profile (`profile_id`) has insufficient available balance to
fund the execution.
- [Already Exists](https://developer.paxos.com/docs/v2/problems/already-exists)
if a conversion with the same external ID (`ref_id`) has already been created.
- [Get Stablecoin Conversion](https://docs.sandbox.paxos.com/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.
- [List Stablecoin Conversions](https://docs.sandbox.paxos.com/api-reference/endpoints/stablecoin-conversion/list-stablecoin-conversions.md): List all conversions, optionally filtering and paging the results.
By default, conversions are returned in reverse chronological (descending)
order by creation time. If no query parameters are supplied,
the response will include up to the last 100 conversions which
were created.
The paginated results default to display up to 100 conversions, unless
otherwise specified with the `limit` parameter. The maximum `limit` value is 1000.
Every paginated response contains a `next_page_cursor` field until the last page is reached.
Pass the `next_page_cursor` value into the `page_cursor` field of a new
request to retrieve the next page of results.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/stablecoin-conversion/overview.md): Convert between fiat and stablecoin using the Stablecoin Conversion API.
- [List Statements](https://docs.sandbox.paxos.com/api-reference/endpoints/statements/list-statements.md): List statements based on the provided filters
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/statements/overview.md): A Statement summarizes all eligible stablecoin rewards for a given organization over a fixed time period.
- [List Tax Form Revisions](https://docs.sandbox.paxos.com/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 the most recent.
Tax Form URL links will expire after 60 seconds.
- [List Tax Forms](https://docs.sandbox.paxos.com/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 60 seconds.
Please call ListTaxFormRevisions endpoint for all versions of a single accounts tax forms.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/tax-forms/overview.md): All tax forms are associated to a single account_id.
- [Get Transfer](https://docs.sandbox.paxos.com/api-reference/endpoints/transfers/get-transfer.md): Get a single transfer by ID.
In the polling workflow, this endpoint can be called to monitor transfer
status changes.
- [List Transfers](https://docs.sandbox.paxos.com/api-reference/endpoints/transfers/list-transfers.md): List all transfers, optionally filtering and paging the results.
By default, transfers are returned in reverse chronological (descending)
order by creation time.
The recommended polling workflow is to query the results in ascending
order (by setting `order_by` to `CREATED_AT`), keeping track of the
`created_at` timestamp of the most recent transfer in the paged results.
Once transfers are discovered, the caller should store the returned `ID`
and query GetTransfer to retrieve status updates.
- [Overview](https://docs.sandbox.paxos.com/api-reference/endpoints/transfers/overview.md): Each deposit to and withdrawal from a Paxos account is a Transfer.
- [identity_documents_required](https://docs.sandbox.paxos.com/api-reference/events/identity-documents-required-object.md): Event object returned for identity.documents_required events
- [identity_kyc_refresh](https://docs.sandbox.paxos.com/api-reference/events/identity-kyc-refresh-object.md): Event object returned for KYC refresh events
- [identity_summary_status_change](https://docs.sandbox.paxos.com/api-reference/events/identity-status-change-object.md): Event object returned for identity status change events
- [transfer_status_change](https://docs.sandbox.paxos.com/api-reference/events/transfer-status-change-object.md): Event object returned for transfer status change events
- [Paxos API](https://docs.sandbox.paxos.com/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.
- [Create Orchestration Rule](https://docs.sandbox.paxos.com/api-reference/preview/orchestration-rules/create-orchestration-rule.md): Creates an orchestration rule that will be triggered by deposits to a source resource.
Invocations of orchestration rules will create Orchestrations, which can be queried using
ListOrchestrations. Orchestration rules can be listed using ListOrchestrationRules.
- [List Orchestration Rules](https://docs.sandbox.paxos.com/api-reference/preview/orchestration-rules/list-orchestration-rules.md): Lists orchestration rules according to the given filters.
Results can be paginated using the next_page_cursor.
The maximum page size is 100.
- [Create Orchestration](https://docs.sandbox.paxos.com/api-reference/preview/orchestrations/create-orchestration.md): Creates an orchestration rule that will be triggered by deposits to a source resource.
The orchestration defines how assets should be moved from a source to a destination,
potentially including conversions between different asset types.
A request to create an orchestration can fail with one of the following
types of errors:
- [Insufficient Funds](https://developer.paxos.com/docs/v2/problems/insufficient-funds)
if the Profile (`profile_id`) has insufficient available balance to
fund the execution.
- [Already Exists](https://developer.paxos.com/docs/v2/problems/already-exists)
if an orchestration with the same external ID (`ref_id`) has already been created.
- [List Orchestrations](https://docs.sandbox.paxos.com/api-reference/preview/orchestrations/list-orchestrations.md): List all orchestrations, optionally filtering and paging the results.
By default, orchestrations are returned in reverse chronological (descending)
order by creation time. If no query parameters are supplied,
the response will include up to the last 100 orchestrations which
were created.
The paginated results default to display up to 100 orchestrations, unless
otherwise specified with the `limit` parameter. The maximum `limit` value is 1000.
Every paginated response contains a `next_page_cursor` field until the last page is reached.
Pass the `next_page_cursor` value into the `page_cursor` field of a new
request to retrieve the next page of results.
When filtering by profile IDs using the `profile_ids` parameter, there is a limit of 100 profiles
that can be specified in a single request.
Orchestrations are provided for various operations including:
- Deposits to a paxos-platform crypto address or bank account
- Withdrawals to a customer-owned crypto address or bank account
- Conversions from one asset to another
- Orchestrated workflows involving some or all of the above
- Invocation of an Orchestration Rule
- [Overview](https://docs.sandbox.paxos.com/api-reference/preview/overview.md): Learn more about the Paxos early access program for developers.
- [identity.approved](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-approved.md): Webhook triggered when an identity verification is approved
- [identity.denied](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-denied.md): Webhook triggered when an identity verification is denied
- [identity.disabled](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-disabled.md): Webhook triggered when an identity is disabled
- [identity.documents_required](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-documents-required.md): Webhook triggered when additional documents are required for identity verification
- [identity.kyc_refresh.completed](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-kyc-refresh-completed.md): Webhook triggered when a KYC refresh process is successfully completed
- [identity.kyc_refresh.expired](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-kyc-refresh-expired.md): Webhook triggered when a KYC refresh process expires without completion
- [identity.kyc_refresh.started](https://docs.sandbox.paxos.com/api-reference/webhooks/identity-kyc-refresh-started.md): Webhook triggered when a KYC refresh process is initiated
- [transfer.act_deposit.completed](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/api-reference/webhooks/transfer-act-deposit-failed.md): Webhook triggered when a fiat deposit via DBS has failed or been cancelled
- [transfer.act_deposit.pending](https://docs.sandbox.paxos.com/api-reference/webhooks/transfer-act-deposit-pending.md): Webhook triggered when a fiat deposit via DBS has been initiated and is pending
- [transfer.act_withdrawal.completed](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/api-reference/webhooks/transfer-act-withdrawal-failed.md): Webhook triggered when a fiat withdrawal via DBS has failed or been cancelled
- [transfer.act_withdrawal.pending](https://docs.sandbox.paxos.com/api-reference/webhooks/transfer-act-withdrawal-pending.md): Webhook triggered when a fiat withdrawal via DBS has been initiated and is pending
- [transfer.crypto_deposit.completed](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/api-reference/webhooks/transfer-crypto-deposit-failed.md): Webhook triggered when a crypto deposit has failed or been cancelled
- [transfer.crypto_deposit.pending](https://docs.sandbox.paxos.com/api-reference/webhooks/transfer-crypto-deposit-pending.md): Webhook triggered when a crypto deposit is detected on-chain and is pending confirmation
- [transfer.crypto_withdrawal.completed](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/api-reference/webhooks/transfer-crypto-withdrawal-failed.md): Webhook triggered when a crypto withdrawal has failed or been cancelled
- [transfer.crypto_withdrawal.pending](https://docs.sandbox.paxos.com/api-reference/webhooks/transfer-crypto-withdrawal-pending.md): Webhook triggered when a crypto withdrawal has been initiated and is pending
- [Execution Data](https://docs.sandbox.paxos.com/api-reference/websockets/execution-data.md)
- [Execution Data (Market)](https://docs.sandbox.paxos.com/api-reference/websockets/execution-data-market.md)
- [Market Data](https://docs.sandbox.paxos.com/api-reference/websockets/market-data.md)
- [Market Data (Market)](https://docs.sandbox.paxos.com/api-reference/websockets/market-data-market.md)
- [Market Data (Stablecoin)](https://docs.sandbox.paxos.com/api-reference/websockets/market-data-stablecoin.md)
- [Market Data (Stablecoin Market)](https://docs.sandbox.paxos.com/api-reference/websockets/market-data-stablecoin-market.md)
- [Overview](https://docs.sandbox.paxos.com/api-reference/websockets/overview.md): Event-driven connectivity for payments and trading.
- [Changelog](https://docs.sandbox.paxos.com/changelog.md): Product updates and announcements
- [Commissions and Rebates FAQ](https://docs.sandbox.paxos.com/guides/crypto-brokerage/commissions-rebates.md): Get answers to common questions about commissions and rebates.
- [FIX Best Practices](https://docs.sandbox.paxos.com/guides/crypto-brokerage/fix/best-practices.md): Learn about connection management, sequence number management and testing.
- [FIX Certification](https://docs.sandbox.paxos.com/guides/crypto-brokerage/fix/certify.md): Test and verify the FIX implementation in Sandbox before going to Production.
- [Overview](https://docs.sandbox.paxos.com/guides/crypto-brokerage/fix/index.md): Leverage the FIX protocol for crypto trading.
- [FIX Onboarding](https://docs.sandbox.paxos.com/guides/crypto-brokerage/fix/onboard.md): Set Up a Paxos Account, configure connection then certify.
- [Overview](https://docs.sandbox.paxos.com/guides/crypto-brokerage/index.md): Add crypto to your application using REST, FIX and WebSocket APIs.
- [Choosing a Ledgering Strategy](https://docs.sandbox.paxos.com/guides/crypto-brokerage/ledger-type.md): Understand your options for ledgering fiat and cryptocurrency with Paxos.
- [Orders, Precision and Rounding](https://docs.sandbox.paxos.com/guides/crypto-brokerage/orders-precision-rounding.md): Learn about tick size, precision, rounding and other recommendations.
- [Orders & Quotes FAQ](https://docs.sandbox.paxos.com/guides/crypto-brokerage/orders-vs-hrq.md): Get answers to common questions about Orders & Quotes.
- [Overview](https://docs.sandbox.paxos.com/guides/crypto-brokerage/quotes/index.md): Held Rate Quotes (HRQ)
- [HRQ Quickstart](https://docs.sandbox.paxos.com/guides/crypto-brokerage/quotes/quickstart.md): Learn about Paxos's HRQ product and how to submit a quote in less than five minutes.
- [Connect to the WebSocket Market Data Feed](https://docs.sandbox.paxos.com/guides/crypto-brokerage/websocket.md): Open a WebSocket connection to the Sandbox BTC Market Data feed.
- [Sign Up](https://docs.sandbox.paxos.com/guides/dashboard/account.md): Create a business account to get started with the Paxos platform.
- [Addresses](https://docs.sandbox.paxos.com/guides/dashboard/addresses.md): View and manage addresses for transferring crypto off the Paxos platform.
- [Configure API Credentials](https://docs.sandbox.paxos.com/guides/dashboard/admin/api.md): Create and update an OAuth2 client.
- [Approvals](https://docs.sandbox.paxos.com/guides/dashboard/admin/approvals.md): Use Approvals to increase security and prevent mistakes on sensitive actions.
- [Review Entity Settings](https://docs.sandbox.paxos.com/guides/dashboard/admin/entity.md): Get the Entity details and limits.
- [Reports](https://docs.sandbox.paxos.com/guides/dashboard/admin/reports.md): View monthly balances and download daily balance and transaction reconciliation reports.
- [Manage Team](https://docs.sandbox.paxos.com/guides/dashboard/admin/team.md): Manage user access and roles within your Entity.
- [Convert](https://docs.sandbox.paxos.com/guides/dashboard/convert.md): Implement guaranteed 1:1 conversions between USD and Paxos-supported stablecoins.
- [Deposit](https://docs.sandbox.paxos.com/guides/dashboard/deposit.md): Send cash or crypto to the Paxos platform.
- [Fiat Accounts](https://docs.sandbox.paxos.com/guides/dashboard/fiat.md): View and manage banking information to deposit and withdrawal USD.
- [Overview](https://docs.sandbox.paxos.com/guides/dashboard/index.md): Securely deposit, convert, transfer and custody assets with Paxos.
- [Saved Instructions](https://docs.sandbox.paxos.com/guides/dashboard/instructions.md): View and manage instructions for depositing fiat and other assets onto the Paxos platform.
- [Migrate to the Dashboard](https://docs.sandbox.paxos.com/guides/dashboard/migrate-to-dashboard.md): Switch to the Dashboard and access new features and improved workflows.
- [Mint](https://docs.sandbox.paxos.com/guides/dashboard/mint.md): Convert USD to Paxos-issued stablecoins and receive them in an external wallet.
- [Onboard to Paxos](https://docs.sandbox.paxos.com/guides/dashboard/onboard.md): Learn more about the information required to start using the Paxos process.
- [Organization, Entities and Profiles](https://docs.sandbox.paxos.com/guides/dashboard/organization.md): Learn more about the multi-entity experience.
- [Passkeys](https://docs.sandbox.paxos.com/guides/dashboard/passkeys.md): Learn more about using passkeys with the Paxos Dashboard.
- [Redeem](https://docs.sandbox.paxos.com/guides/dashboard/redeem.md): Deposit stablecoin and convert to USD. Transfer USD to your bank.
- [Manage Payouts](https://docs.sandbox.paxos.com/guides/dashboard/rewards/manage-payouts.md): Set or update a payout address.
- [Monitor Addresses](https://docs.sandbox.paxos.com/guides/dashboard/rewards/monitor-addresses.md): Add your first monitoring address.
- [Overview](https://docs.sandbox.paxos.com/guides/dashboard/rewards/overview.md): Manage USDG rewards via the Paxos Dashboard.
- [Timeline and Disputes](https://docs.sandbox.paxos.com/guides/dashboard/rewards/timeline-and-disputes.md): Monthly Rewards Timeline.
- [Roles and Responsibilities](https://docs.sandbox.paxos.com/guides/dashboard/roles.md): Learn more about the default roles for your Entity.
- [Sign In](https://docs.sandbox.paxos.com/guides/dashboard/signin.md): Access the Dashboard using a passkey or SSO.
- [Transactions](https://docs.sandbox.paxos.com/guides/dashboard/transactions.md): Monitor Dashboard & API driven Paxos transactions and balances.
- [Transfer](https://docs.sandbox.paxos.com/guides/dashboard/transfer.md): Move fiat or crypto off the Paxos platform or between Profiles.
- [Travel Rule Compliance](https://docs.sandbox.paxos.com/guides/dashboard/travel-rule.md): Learn more about Travel Rule requirements and the blockchain.
- [Create Developer Account](https://docs.sandbox.paxos.com/guides/developer/account.md): Sign Up for access to the Sandbox environment.
- [AI-Assisted Development](https://docs.sandbox.paxos.com/guides/developer/ai-assisted-development.md): Use AI coding assistants effectively with Paxos documentation and API specifications.
- [Migrate from v1 to v2 API](https://docs.sandbox.paxos.com/guides/developer/api-migrate.md): Learn how to migrate your REST integrations.
- [Authenticate](https://docs.sandbox.paxos.com/guides/developer/authenticate.md): Generate an authentication token.
- [Assets and Blockchains](https://docs.sandbox.paxos.com/guides/developer/blockchains.md): Learn more about supported assets, stablecoins and blockchains.
- [API Breaking Change Policy](https://docs.sandbox.paxos.com/guides/developer/breaking-change/policy.md): Learn about what qualifies as a breaking change and the what happens when one is necessary.
- [Convert](https://docs.sandbox.paxos.com/guides/developer/convert.md): Implement guaranteed 1:1 conversions between USD and Paxos-issued stablecoins.
- [Configure API Credentials](https://docs.sandbox.paxos.com/guides/developer/credentials.md): API credentials using Client ID and Secret. Set allowed scopes to access specific API endpoints.
- [Paxos API FAQ](https://docs.sandbox.paxos.com/guides/developer/faq.md): Get answers to commonly asked questions.
- [Fiat Transfers FAQ](https://docs.sandbox.paxos.com/guides/developer/fiat-transfers/fiat-transfers-faq.md): Get answers to common questions about the Fiat Transfers API.
- [Overview](https://docs.sandbox.paxos.com/guides/developer/fiat-transfers/index.md): Move USD on and off the Paxos Platform via wire transfer or CUBIX.
- [Fiat Transfers Quickstart](https://docs.sandbox.paxos.com/guides/developer/fiat-transfers/quickstart.md): Set up fiat funding and withdraw flows in the Sandbox environment.
- [Statuses](https://docs.sandbox.paxos.com/guides/developer/fiat-transfers/statuses.md): Learn more about Fiat Transfers statuses.
- [Mint](https://docs.sandbox.paxos.com/guides/developer/mint.md): Deposit USD. Convert or convert-and-transfer in one API call.
- [Rate Limits](https://docs.sandbox.paxos.com/guides/developer/rate-limits.md): Review REST, WebSocket and FIX limits.
- [Redeem](https://docs.sandbox.paxos.com/guides/developer/redeem.md): Deposit stablecoin and convert to USD in one API call. Transfer USD to your bank.
- [Reports](https://docs.sandbox.paxos.com/guides/developer/reports.md): View monthly balances and download daily balance and transaction reconciliation reports.
- [Make First API Request](https://docs.sandbox.paxos.com/guides/developer/request.md): Use the access token to retrieve a list of Profiles.
- [Request Signing](https://docs.sandbox.paxos.com/guides/developer/request-signing.md): Use JWS to add an additional layer of security to every request.
- [Sandbox](https://docs.sandbox.paxos.com/guides/developer/sandbox.md): Use the Sandbox environment to mock flows, execute transfers and test integrations.
- [Enhanced Due Diligence](https://docs.sandbox.paxos.com/guides/identity/edd.md): Manage the enhanced due diligence of an Identity on the Paxos Platform.
- [Overview](https://docs.sandbox.paxos.com/guides/identity/index.md): Onboard users directly to the Paxos Platform to accelerate speed to market and outsource your compliance needs.
- [Onboarding an Institution for Crypto Brokerage](https://docs.sandbox.paxos.com/guides/identity/institution-crypto-brokerage.md): Create an Institution Identity, Account and Profile to provide Buy, Hold and Sell Crypto Brokerage for Institutions
- [Institution Types and Members](https://docs.sandbox.paxos.com/guides/identity/institution-types.md): Learn about institution types, member roles, and requirements
- [Periodic KYC Refresh](https://docs.sandbox.paxos.com/guides/identity/kyc-refresh.md): Manage the periodic KYC refresh of an Identity on the Paxos Platform in an automated, compliant way.
- [Onboarding a Person for Crypto Brokerage](https://docs.sandbox.paxos.com/guides/identity/person-crypto-brokerage.md): Create an Identity, Account and Profile to provide Buy, Hold and Sell Crypto Brokerage for Users
- [Required Details](https://docs.sandbox.paxos.com/guides/identity/required-details.md): Learn more about what details are required when creating an Identity
- [Statuses](https://docs.sandbox.paxos.com/guides/identity/statuses.md): Learn more about Identity statuses and sub-statuses
- [Payments FAQ](https://docs.sandbox.paxos.com/guides/payments/faq.md): Get answers to common questions about payments.
- [Overview](https://docs.sandbox.paxos.com/guides/payments/index.md): Accept stablecoin pay-ins with real-time settlement. Issue on-chain refunds.
- [Stablecoin Pay-ins Quickstart](https://docs.sandbox.paxos.com/guides/payments/quickstart.md): Accept stablecoin pay-ins with real-time settlement. Issue on-chain refunds.
- [Statuses](https://docs.sandbox.paxos.com/guides/payments/status.md): Learn more about payment statuses.
- [Connect to the WebSocket Stablecoin Price Feed](https://docs.sandbox.paxos.com/guides/payments/websocket.md): Open a WebSocket connection to the Sandbox USDCUSD feed.
- [FAQ](https://docs.sandbox.paxos.com/guides/settlements/faq.md): Get answers to common questions about the Settlements API.
- [Overview](https://docs.sandbox.paxos.com/guides/settlements/index.md): Propose, approve and manage two-way atomic transfers.
- [Notifications](https://docs.sandbox.paxos.com/guides/settlements/notification.md): Understand how settlement notifications work.
- [Quickstart](https://docs.sandbox.paxos.com/guides/settlements/quickstart.md): Set up and complete the settlement workflow in the Sandbox environment.
- [Statuses](https://docs.sandbox.paxos.com/guides/settlements/status.md): Learn more about settlement statuses.
- [BUSD](https://docs.sandbox.paxos.com/guides/stablecoin/busd.md): Redeem or convert BUSD on the Paxos platform.
- [Stablecoins](https://docs.sandbox.paxos.com/guides/stablecoin/index.md): Use Paxos-issued stablecoins for payments, money movement and more.
- [Integrate with PYUSD on Ethereum](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/guides/stablecoin/pyusd/mainnet.md): Get the PYUSD mainnet addresses.
- [PYUSD on Test Networks](https://docs.sandbox.paxos.com/guides/stablecoin/pyusd/testnet.md): Get the PYUSD testnet addresses.
- [USDG Overview](https://docs.sandbox.paxos.com/guides/stablecoin/usdg/index.md): Use Global Dollar for payments, settlements, treasury and more.
- [USDG on Main Networks](https://docs.sandbox.paxos.com/guides/stablecoin/usdg/mainnet.md): Get the USDG token addresses.
- [Getting Started with USDG (Global Dollar)](https://docs.sandbox.paxos.com/guides/stablecoin/usdg/quickstart.md): How to Access USDG.
- [USDG on Test Networks](https://docs.sandbox.paxos.com/guides/stablecoin/usdg/testnet.md): Get the USDG token addresses.
- [USDL Overview](https://docs.sandbox.paxos.com/guides/stablecoin/usdl/index.md): Use Lift Dollar for payments, settlements and treasury while earning on-chain yield.
- [USDL on Main Networks](https://docs.sandbox.paxos.com/guides/stablecoin/usdl/mainnet.md): Get the USDL token addresses.
- [USDL on Test Networks](https://docs.sandbox.paxos.com/guides/stablecoin/usdl/testnet.md): Get the USDL token addresses.
- [USDP Overview](https://docs.sandbox.paxos.com/guides/stablecoin/usdp/index.md): Learn more about the Fully backed, legally protected, always available Pax Dollar.
- [USDP on Main Networks](https://docs.sandbox.paxos.com/guides/stablecoin/usdp/mainnet.md): Get the USDP mainnet addresses.
- [USDP on Test Networks](https://docs.sandbox.paxos.com/guides/stablecoin/usdp/testnet.md): Get the USDP testnet addresses.
- [Webhooks FAQ](https://docs.sandbox.paxos.com/guides/webhooks/faq.md): Get answers to common questions about webhooks.
- [Overview](https://docs.sandbox.paxos.com/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://docs.sandbox.paxos.com/guides/webhooks/quickstart.md): Create and register a webhook consumer to start receiving events.
- [Retries and Limits](https://docs.sandbox.paxos.com/guides/webhooks/retries-and-limits.md): Learn about webhook delivery retries, retry policies, and rate limits for Paxos webhooks.
- [Build with Paxos](https://docs.sandbox.paxos.com/welcome.md): Learn how to get started with the Paxos API and Platform.
## 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/)