v1

latestOpenAPI 3.0.02026-07-268955283.0 KB

Get connections by user

get/connections

Query parameters

customerIdstring

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

contactIdstring

The phone number of a contact created through an extended journey (like loans)

limitnumber

Max number of documents to retrieve

sort1 | -1

1 for ascending, -1 for descending

nextPagestring

page to retrieve, used for pagination

status'ACTIVE'

status to retrieve, used for filtering

Response

nextPagestring nullable

Pagination cursor for the next page; null when there are no more pages

countnumber

Number of connection documents returned in items for this response (before optional status filter)

Example response

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