Skip to content

Clarify request signing requirement for crypto withdrawals #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Clarify request signing requirement for crypto withdrawals #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a920ba0
Clarify request signing requirement for crypto withdrawals
mintlify[bot] Feb 27, 2026
300c2f0
Fix wording: clarify crypto withdrawals fail until backend configured
mintlify[bot] Feb 27, 2026
09dffb6
Add request signing note to Create Crypto Withdrawal endpoint
mintlify[bot] Feb 27, 2026
3f4cbd2
Fix wording: clarify request signing conditional behavior
mintlify[bot] Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api-reference/endpoints/crypto-withdrawals/create-crypto-withdrawal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
openapi: post /transfer/crypto-withdrawals
---

<Note>
If you have [request signing](/guides/developer/request-signing) enabled, this endpoint will not work until Paxos configures it on the backend. Contact [Support](https://support.paxos.com) to complete the setup.
</Note>

```bash OAuth Scope
transfer:write_crypto_withdrawal
```
4 changes: 2 additions & 2 deletions guides/developer/request-signing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Use JWS to add an additional layer of security to every request.
Request signing adds an additional layer of security to every request you send to Paxos, and can help protect your account should your Paxos API Client ID and Secret become compromised.
Once request signing is enabled on your account, Paxos rejects all unsigned requests to authenticated endpoints.

> Request signing must be activated by Paxos. Contact [Support](https://support.paxos.com) to get started.
> Request signing must be activated by Paxos before you can use the [Create Crypto Withdrawal](/api-reference/endpoints/crypto-withdrawals/create-crypto-withdrawal) endpoint. All other authenticated endpoints will work with request signing, but crypto withdrawals will fail until Paxos configures this on the backend. Contact [Support](https://support.paxos.com) to enable request signing for your account.

Signed requests use your own private key, similar to [mTLS](https://www.cloudflare.com/learning/access-management/what-is-mutual-tls/) or [SSH](https://www.ssh.com/academy/ssh/public-key-authentication) public authentication, and then attach the signature to the request as the `Paxos-Signature HTTP header`, using the JSON Web Signature (JWS) format.

Expand Down Expand Up @@ -46,7 +46,7 @@ Go to **Admin > API** in either [Sandbox][admin-api-sandbox] or [Production][ad

Go to ** Admin > API** in either [Sandbox](https://dashboard.sandbox.paxos.com/admin/api) or [Production](https://dashboard.paxos.com/admin/api) and find the **API Credentials** that require request signing.

> Request signing must be activated by Paxos. Contact [Support](https://support.paxos.com) to get started.
> Request signing must be activated by Paxos before you can use the [Create Crypto Withdrawal](/api-reference/endpoints/crypto-withdrawals/create-crypto-withdrawal) endpoint. All other authenticated endpoints will work with request signing, but crypto withdrawals will fail until Paxos configures this on the backend. Contact [Support](https://support.paxos.com) to enable request signing for your account.

Scroll down and use **Edit API Credentials** to make changes.
Switch **Request Signing** to open the edit dialogue and add your _Public Key_.
Expand Down
Loading