Castle API uses a Bearer Token to authenticate all requests. This key is obtain through the Token Exchange on OAuth Authorization flow.
Authentication to the API is performed with a key. Provide the Bearer Token on the Authorization header.
You can request an OAuth Client access via [email protected]
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests missing authentication will also fail.
| Key | Value |
|---|---|
| Authorization | Bearer Key |
Scopes
Scopes define the specific permissions an OAuth Client requests during authentication. Rather than granting full access to an account, they let an app request only the access it actually needs. Apps should ask for the minimum set of permissions required to function, reducing risk if a token is ever leaked or misused.
The table below lists the scopes currently available, along with what each on grants access t.o
| Scope | Description |
|---|---|
cash:account:read | View Cash Account deposit information |
cash:address:write | Whitelist new Stablecoin address for Cash withdrawals |