Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paxos.com/llms.txt

Use this file to discover all available pages before exploring further.

Most API endpoints require authentication with a Client ID and Secret. Each Client ID has a specific set of allowed scopes (Permissions) to access API endpoints. Scopes allowed on an API client may be updated at any time in the Dashboard Admin > API Management section.
Contact your Entity Manager if you need permissions to manage API credentials.
When setting scopes, Paxos recommends following the principle of least privilege and only allow scopes required by a specific application. Scopes for each endpoint are listed in the Authorizations section in the API Reference docs. The Market Data and most Pricing endpoints do not require authorization.
  1. Go to Admin > API Management to add new credentials.
The Developer Sandbox is completely segregated from production, so credential configuration must take place in both environments.
  1. Create a Label for your API credentials and select the Scopes for your Client ID. For example, the following scopes (space delimited) should be adequate to mint, redeem and convert Paxos-issued stablecoins:

    orchestration:read_orchestration
orchestration:write_orchestration
orchestration:read_orchestration_rule
orchestration:write_orchestration_rule
funding:read_profile
funding:write_profile
transfer:read_deposit_address
transfer:read_transfer
transfer:read_fiat_account
transfer:read_fiat_deposit_instructions
transfer:write_internal_transfer
transfer:write_crypto_withdrawal
transfer:write_deposit_address
transfer:write_fiat_account
transfer:write_fiat_deposit_instructions
transfer:write_fiat_withdrawal
  2. Save the credentials.
  3. Copy the Client ID and Client Secret and store them in a safe place. The secret will not be displayed in the UI again and will have to be reset if forgotten.
Once you have the Client ID and Client Secret, you can authenticate in Sandbox.