Authorize with a Data Provider

get https://ob.flinksapp.com/api/v1/authorize

Use the /api/v1/authorize endpoint to initiate the authorization process with a particular Data Provider.

Authorization Example

https://ob.flinksapp.com/api/v1/authorize?
response_type=code
&client_id=clientid
&redirect_uri=https%3A%2F%2Fexample.com%2Fcallback
&scope=ACCOUNT_BASIC%20ACCOUNT_DETAILED%20ACCOUNT_PAYMENTS%20INVESTMENTS%20TRANSACTIONS%20STATEMENTS%20CUSTOMER_CONTACT%20CUSTOMER_PERSONAL
&state=state
&provider_id=1000
&correlation_id=fce84d61-dfa8-4e2b-bd94-f1ec6a445841

https://www.example.com/callback?
code=code
&state=state

https://www.example.com/callback?
error=access_denied
&error_description=The user denied the access
&state=state

How to handle an error response

If you receive an error response, refer to the List of Authorization Errors for more information about the error and how to resolve it.

Query Params

client_id

string

required

The ID of the Data Recipient that you want to initiate the authorization process with.

redirect_uri

string

required

The URL of the web page that you want to return the user to after the authorization process is complete.

state

string

required

A randomly generated, unique string that's linked to this particular request. This adds an extra layer of security and is an OAuth 2.0 standard.

For the request to be successful, this string must be validated to confirm it's being passed with the correct request.

response_type

string

required

Defaults to code

Tells your server the type of response it can expect to receive from this request.

For this use case, pass code as the value for this field to tell your server that you're sending an authorization code.

scope

string

required

The scope of data that the Data Recipient collects from the customer, and is populated on the consent screen. To work with this Data Recipient, the customer must provide consent to share the scope of data they require. Possible values include the following:

- ACCOUNT_BASIC = Basic account information
- ACCOUNT_DETAILED = Detailed account information
- ACCOUNT_PAYMENTS = Payment information linked to the account
- INVESTMENTS = Investment information linked to the account
- STATEMENTS = PDF statements for the account
- CUSTOMER_CONTACT = Business contact information for the account
- CUSTOMER_PERSONAL = Information about the customer who owns the account
- TRANSACTIONS = List of transactions for the account

This is a space separated list.

The minimum scope required is: ACCOUNT_BASIC

provider_id

int32

required

The ID of the Data Provider that you are authorizing.

correlation_id

string

A randomly-generated, unique identifier that correlates two or more requests.

lang

string

Defaults to en

The language that you want to display on the consent screen:

- en = English
- fr = French

If this field is left empty, the default value is English.

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://ob.flinksapp.com/api/v1/authorize?response_type=code&lang=en' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Authorization Example

How to handle an error response

302302