Create OAuth Key
OAuth Details
refresh_token
String
Required during POST
Token used to generate an OAuth Object.
scope
Array of Strings
Required during POST
Fingerprints
As fingerprints are required for OAuth key generation calls, there are options to consider related to the users fingerprint.
is_active
Boolean
Optional
Will execute the MFA flow, to allow changing of is_protected fingerprint value.
is_protected
Boolean
Optional (Requires is_active:true)
OAuth
POST
https://api.synapsefi.com/v3.1/oauth/:user_id
This endpoint allows you to generate an OAuth token for a specific user so that you can perform necessary actions on behalf of the user.
Path Parameters
user_id
string
ID of the user you wish to generate an OAuth token for.
Headers
X-SP-USER
string
OAuth key and device fingerprint of the user separated by a pipe. In this API call, only the device fingerprint is required.
X-SP-USER-IP
string
IP Address of the user device.
X-SP-GATEWAY
string
Your Client ID and Secret separated by a pipe.
Request Body
validation_pin
string
In case of MFA verification, the code delivered to the phone_number.
phone_number
string
Phone number where the MFA code will be sent in an instance of a new fingerprint registration.
scope
array
Array of Scopes the OAuth key will allow. Go to Possible Scopes to learn more.
refresh_token
string
Refresh token associated with the user.
Example Request
Last updated