v1

latestOpenAPI 3.0.02026-07-268955283.0 KB

Create connection

post/connections

Request body

customerIdstring

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

startDatestring date

The date which from transactions would be collected

expiryDatestring date-time

The date at which the connection should expire

paymentIdstring

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

journeyIdstring

The journey id the connection was created in

language'he' | 'en'

The language of the connection (he / en)

externalIdstring

An optional external id that can be given to a connection

agentEmailstring

The email of the agent

providerIdsstring[]

includeFakeProvidersboolean

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

refreshDataboolean

If true, this connection will automatically get new transactions data

iframeboolean

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

psuIdstring

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

psuCorporateIdstring

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

redirectUrlstring

An optional url to be redirected after a successful connection

connectionModestring

allowBusinessboolean

If true this connection will allow business accounts

restrictedTostring[]

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

psuIdTypestring

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

isPlaidSandboxboolean

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

redirectWithoutButtonClickboolean

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

allowInsuranceboolean

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

Example request

{
  "access": {
    "accounts": [
      {
        "iban": "IL123456789012345678901",
        "bban": "10-944-50151142"
      }
    ],
    "balances": [
      {
        "iban": "IL123456789012345678901",
        "bban": "10-944-50151142"
      }
    ],
    "transactions": [
      {
        "iban": "IL123456789012345678901",
        "bban": "10-944-50151142"
      }
    ]
  }
}

Response

idstring

A unique identifier for the connection

connectUrlstring

A link forwarding the end-user to the consent journey