Configure API Credentials

Create and updated an OAuth2 client.

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, we recommend 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.

   • Developer Sandbox: https://dashboard.sandbox.paxos.com/admin/api
   • Production: https://dashboard.paxos.com/admin/api

2. 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:
   
   

   conversion:read_conversion_stablecoin
   conversion:write_conversion_stablecoin
   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
3. Save the credentials.
4. 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.