post https://uat-api.synapsefi.com/v3.1/oauth/
To perform an action for a user, you need to supply a valid OAuth Key in the header field of the API request
Request Body
| Key | Type | Description |
|---|---|---|
| refresh_token | string | [Required] User-specific refresh token for oauth (expires after 10 uses) |
| scope | array of strings | Defines the level of access a user's oauth_token provides. By default, the oauth_token provides access to all available scopes. To limit this, set scope in the request body. |
OAuth Expiration
OAuth keys expire every two hours. Remember to account for this when building out your application
Available Scopes
| Scope | Comment |
|---|---|
| USER|PATCH | OAuth can be used to update User document |
| USER|GET | OAuth can be used to get User |
| NODES|POST | OAuth can be used to add Nodes |
| NODES|GET | OAuth can be used to get Nodes |
| NODE|GET | OAuth can be used to get Node |
| NODE|PATCH | OAuth can be used to update Node |
| NODE|DELETE | OAuth can be used to delete Node |
| TRANS|POST | OAuth can be used to add Transaction |
| TRANS|GET | OAuth can be used to get Transaction |
| TRAN|GET | OAuth can be used to get Transaction |
| TRAN|PATCH | OAuth can be used to update Transaction |
| TRAN|DELETE | OAuth can be used to cancel Transaction |
| SUBNETS|POST | OAuth can be used to create Subnets |
| SUBNETS|GET | OAuth can be used to get Subnets |
| SUBNET|GET | OAuth can be used to get a Subnet |
| SUBNET|PATCH | OAuth can be used to update a Subnet |
| STATEMENTS|GET | OAuth can be used to get Statements |
| STATEMENT|GET | OAuth can be used to get a Statement |