Initiate a connection to open banking

post/connect/open-banking-init

Request

Base URL
https://api.open-finance.ai/v2
URL
https://api.open-finance.ai/v2/connect/open-banking-init
Auth
OAuth 2
Client credentials
Token URL: https://api.open-finance.ai/oauth/token scopes: create:connections

Request body

A unique identifier for the provider

connectionIdstring required

A unique identifier for the connection

psuIdstring required

The national ID or passport number of the user

psuIdTypestring

The type of the PSU ID

psuCorporateIdstring

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

psuCorporateIdTypestring

The type of the corporate PSU ID

expiryDatestring date

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

refreshDataboolean

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

restrictedTostring[]

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

customerApprovalGrantedboolean

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

Response

Response - successfully handled process

scaOAuthstring

The link to the bank

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.