Developers will need to register their application before getting started. A registered application will be assigned a unique Client Id and Client Secret.
**Security Notice**: Your *Client Secret* should never be shared, must be kept secret at all times and should only be used from your server-side application.- For security reasons, your application must be secured with a valid SSL certificate issued by a known Certificate Authority.
- Likewise, the provided Redirect URL when registering the application must be a valid static subresource. Notice that this property cannot be dynamically reconfigured during authorization requests for security reasons.
- Users can revoke access to your application at any time. Your application must be prepared for this and, if necessary, should request authorization from the user again.
- Your application may be suspended in an automated fashion in accordance with our Terms of Service.
- Standard rate limits apply to all issued access tokens.
When requesting authorization from a user the application must specify the level of access needed. These scopes are displayed to the user on the authorization form and currently the user cannot opt-out of individual scopes.
The following scopes are supported by the API:
| Scope | Description |
|---|---|
| cards:read | Can view all cards and their information. |
| cards:write | Can create and update any card. |
| contacts:read | Can view all contacts and their information. |
| contacts:write | Can create and update any contact. |
| transactions:read | Can view any transaction. |
| transactions:write | Can create a transaction from any card to any destination (another card or an external address), cancel and resend transactions. |
| user:read | Can view the user and their information. |
You can always request more scopes later by asking for user consent again.
We prefer that you use these image resources when connecting your applications to Bitreserve.
small (119x40), large (238x80)
small (119x40), large (238x80)
small (119x40), large (238x80)
small (222x40), large (443x80)
