Create connection

post

https://{API_PREFIX}.open-finance.ai/v2/connections

Body Params

customerId

string

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

startDate

date

The date which from transactions would be collected

expiryDate

date-time

The date at which the connection should expire

paymentId

string

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

journeyId

string

The journey id the connection was created in

language

string

enum

The language of the connection (he / en)

Allowed:

externalId

string

An optional external id that can be given to a connection

agentEmail

string

The email of the agent

providerIds

array of strings

providerIds

callbackInformation

object

includeFakeProviders

boolean

Defaults to false

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

refreshData

boolean

Defaults to false

If true, this connection will automatically get new transactions data

iframe

boolean

Defaults to false

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

psuId

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

psuCorporateId

string

length between 8 and 9

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

redirectUrl

string

An optional url to be redirected after a successful connection

connectionMode

string

Defaults to PSD2

allowBusiness

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

psuIdType

string

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

isPlaidSandbox

boolean

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

redirectWithoutButtonClick

boolean

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

allowInsurance

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

201Response

400production access is not enabled for this organization, you must include fake providers or contact us