API Reference

Create connection

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

The ID of the customer (business ID / national ID) created through an extended journey (like loans)

date

The date which from transactions would be collected

date-time

The date at which the connection should expire

string

If this connection is created for a payment process you can define it here with a unique payment identifier

string

The journey id the connection was created in

string
enum

The language of the connection (he / en)

Allowed:
string

An optional external id that can be given to a connection

string

The email of the agent

providerIds
array of strings
providerIds
callbackInformation
object

Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)

boolean
Defaults to false

If true, this connection can be used for testing purposes vs. a fake bank provider

boolean
Defaults to false

If true, this connection will automatically get new transactions data

boolean
Defaults to false

If true, this connection send post messages for status notifications in an iframe

string
length between 5 and 9

incase you want to define ahead of time the user national id of passport and block him from changing it

string
length between 8 and 9

incase you want to define ahead of time the user corporate id and block him from changing it

string

An optional url to be redirected after a successful connection

string
Defaults to PSD2
boolean
Defaults to false

If true this connection will allow business accounts

access
object

The access object is used to define the permissions you want to give to the connection

restrictedTo
array of strings

The restrictedTo object is used to define the permissions you want to give to the connection

restrictedTo
string

The type of the PSU ID, validated based on the provider ID.

boolean

If true, this connection will be treated as a sandbox connection for Plaid.

boolean

If true, this connection will be redirected automatically without the user needing to click a button.

boolean

If true, this connection will allow insurance-related data to be accessed.

Responses

401

Unauthorized access - Invalid access token

403

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

404

Organization not found in auth0 token

500

Internal server error

Updated 11 months ago

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 11 months ago