OPopen-finance

Get connection by ID

get/connections/{connectionId}

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/connections/{connectionId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: read:connections

Path parameters

connectionIdstring required

A unique identifier for the connection

Response

Response

idstring

A unique identifier for the connection

userIdstring

A unique identifier for the user

customerIdstring nullable

Customer identifier for extended journeys (e.g. loans)

psuIdstring nullable

The national id or passport number of the user

psuIdTypestring nullable

The type of the PSU ID

psuCorporateIdstring nullable

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

providerIdstring nullable

A unique identifier for the provider

status'ACTIVE' | 'CONNECTED' | 'FETCHING' | 'ERROR' | 'FETCHING_ERROR' | 'INACTIVE' | 'COMPLETED' | 'CREDENTIALS_ERROR' | 'REJECTED' | 'PARTIALLY_AUTHORIZED' | 'UNKNOWN' | 'TERMINATED_BY_USER' | 'EXPIRED' | 'REVOKED' | 'REPLACED' | 'SUSPENDED_BY_PROVIDER'

The connection status

mode'PSD2' | 'PLAID'

The connection mode (open banking vs Plaid)

expiryDatestring date

The date at which the connection/consent expires

accountsnumber nullable

Number of checking accounts associated with the connection

cardsnumber nullable

Number of credit-cards associated with the connection

savingsnumber nullable

Number of savings accounts associated with the connection

loansnumber nullable

Number of loans accounts associated with the connection

securitiesnumber nullable

Number of security accounts associated with the connection

transactionsnumber nullable

Number of transactions associated with the connection

providerIdsstring[]

Allowed provider IDs for this connection. Enum must match PROVIDERS_IDS_LIST in src/consts.ts (see tests/data/connection-openapi.spec.ts).

includeFakeProvidersboolean nullable

If true, allow usage of dummy bank

excludeCreditCardProvidersboolean nullable

If true, credit-card providers are excluded from this connection

isFakeboolean nullable

If true, the connection targets sandbox / fake providers. Sample responses use JSON boolean true/false, not the string "true".

restrictedTostring[]

Product types this connection is restricted to

iframeboolean nullable

Whether the consent journey should display as an iframe

contactIdstring nullable

Phone number of a contact from an extended journey (e.g. loans).

redirectUrlstring nullable

An optional URL to be redirected after a successful connection

startDatestring date

The date from which transactions would be collected

createdAtstring date-time nullable

The timestamp in UTC when the connection was created

updatedAtstring date-time nullable

The timestamp in UTC when the connection was last updated

scaOAuthstring nullable

URL for OAuth-based Strong Customer Authentication

verifierstring nullable

Verifier used for verifying the connection

lastFetchedDataDatestring date nullable

Last date at which transactions have been fetched

languagestring nullable

The language to use in the consent journey, if not set the user will be able to choose the language

paymentIdstring nullable

Related payment identifier when the connection was created from a payment flow

allowBusinessboolean nullable

Indicates if the connection allows business accounts

allowInsuranceboolean nullable

Indicates if the connection allows insurance-related data

isPriorityboolean

Whether this connection is treated as priority for processing

customerApprovalGrantedboolean nullable

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

Example response

{
  "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.