API Reference

Initiate a connection to open banking

post
https://{API_PREFIX}.open-finance.ai/v2/connect/open-banking-init
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

A unique identifier for the provider

string
required

A unique identifier for the connection

string
required
length between 5 and 9
^[0-9]+$

The national ID or passport number of the user

string

The type of the PSU ID

string
length between 8 and 9
^[0-9]+$

The ID of a customer (business ID / national ID)

string

The type of the corporate PSU ID

date

The date at which the connection should expire. Contact us to use this property

boolean

Whether the connection data should be refreshed or not. Contact us to use this property

restrictedTo
array of strings

The restrictedTo object is used to define the permissions you want to give to the connection, Contact us to use this property

restrictedTo
Allowed:
boolean

Indicates whether the end user has approved the customer approval terms. Only sent when the feature is enabled on the organization

Responses

401

Unauthorized access - Invalid access token

403

Forbidden - Access token missing the required permissions to preform this action

404

provider not found - providerId didn't match any provider

500

Internal server error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?