OAuth Object Details

OAuth Schema

Key	Type	Required	Description
client_id	String	N.A. Included in API response.	The Primary Key that denotes your client object in our system.
client_name	String	N.A. Included in API response.	Your common name in our system.
expires_at	Number	N.A. Included in API response.	Unix timestamp (in ms) value of when the OAuth object was created.
expires_in	Integer	N.A. Included in API response.	Countdown (in sec) of when the OAuth key will expire.
oauth_key	String	N.A. Included in API response.	OAuth key that you will be using to authenticate user level requests.
refresh_expires_in	Integer	N.A. Included in API response.	Number of times the same refresh token can be used to issue a new OAuth key.
refresh_token	String	Yes. But the response might have a new value if your supplied refresh token will expire after this request.	Token used to generate an OAuth Object.
scope	Array of String	No. Default are all Possible Scopes.	Scopes denote which API calls and actions the OAuth key is allowed to do. This field is worth customizing if you will be sending the OAuth key to the client device for certain actions reducing the damage a man-in-the-middle attack can do.
user_id	String	N.A. Included in API response.	The Primary Key that denotes the user object in our system.

Possible Scopes

Scope	Description
USER|PATCH	PATCH requests on /users/userid can be sent. Eg. Updating KYC on user object.
USER|GET	GET requests on /users/userid can be sent. Eg. Viewing user KYC.
NODES|POST	POST requests on /users/userid/nodes can be sent. Eg. Creating a deposit account.
NODES|GET	GET requests on /users/userid/nodes can be sent. Eg. Viewing all payment accounts liked to the user.
NODE|PATCH	PATCH requests on /users/userid/nodes/nodeid can be sent. Eg. Verifying micro-deposits.
NODE|DELETE	DELETE requests on /users/userid/nodes/nodeid can be sent. Eg. Deleting a payment account from the user profile.
TRANS|POST	POST requests on /users/userid/nodes/nodeid/trans can be sent. Eg. Creating a new payment transaction.
TRANS|GET	GET requests on /users/userid/nodes/nodeid/trans can be sent. Eg. Viewing all payment transactions the user has made or received.
TRAN|GET	GET requests on /users/userid/nodes/nodeid/trans/tranid can be sent. Eg. Viewing a specific payment that was either sent or received by the user.
TRAN|PATCH	PATCH requests on /users/userid/nodes/nodeid/trans/tranid can be sent. Eg. Commenting on the transaction or approving a quote.
TRAN|DELETE	DELETE requests on /users/userid/nodes/nodeid/trans/tranid can be sent. Eg. Canceling a transaction.
SUBNETS|POST	POST requests on /users/userid/nodes/nodeid/subnets can be sent. Eg. Issuing a card.
SUBNETS|GET	GET requests on /users/userid/nodes/nodeid/subnets can be sent. Eg. View all cards issued to the user.
SUBNET|GET	GET requests on /users/userid/nodes/nodeid/subnets/subnetid can be sent. Eg. View a card.
SUBNET|PATCH	PATCH requests on /users/userid/nodes/nodeid/subnets/subnetid can be sent. Eg. Activating a card.
STATEMENTS|GET	GET requests on /users/userid/nodes/nodeid/statements can be sent. Eg. Viewing all statements associated with a node.
STATEMENT|GET	GET requests on /users/userid/nodes/nodeid/statements/statementid can be sent. Eg. Viewing a statement.
STATEMENTS|POST	POST requests on /users/userid/nodes/nodeid/statements can be sent. Eg. Generating an AdHoc statement.
CONVERSATIONS|POST	Currently scope in internal testing. More to come later.
CONVERSATIONS|GET	Currently scope in internal testing. More to come later.
CONVERSATION|GET	Currently scope in internal testing. More to come later.
CONVERSATION|PATCH	Currently scope in internal testing. More to come later.
MESSAGES|POST	Currently scope in internal testing. More to come later.
MESSAGES|GET	Currently scope in internal testing. More to come later.
MESSAGE|GET	Currently scope in internal testing. More to come later.
MESSAGE|PATCH	Currently scope in internal testing. More to come later.