v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Open Banking

List Open Banking Data

Returns a paginated list of Open Banking Data related to an Inscribe customer. The list is sorted by creation date in ascending order, with the oldest data appearing first.

get/customers/{customer_id}/open_banking_data

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Query parameters

sizeinteger required

Set the number of Open Banking Data records to be returned by the request.

cursorstring uuid

Send a cursor to retrieve the next set of Open Banking Data records, starting after the cursor. If no cursor is sent, the first set of Open Banking Data records will be returned.

Response

Successfully retrieved Open Banking Data records.

Example response

{
  "data": [
    {
      "id": "3fc4560f-f6dc-4cdd-a076-182a5e92b70b",
      "created_at": "2022-07-14T09:46:10.510Z",
      "state": "PROCESSED",
      "no_of_bank_accounts": 3
    },
    {
      "id": "18a51c48-b387-43a3-a405-6eb63c13c70a",
      "created_at": "2022-08-04T11:56:01.460Z",
      "state": "PROCESSED",
      "no_of_bank_accounts": 1
    },
    {
      "id": "a28df285-baca-47b2-aae0-e3f085a096d2",
      "created_at": "2022-10-15T16:55:32.098Z",
      "state": "PROCESSING",
      "no_of_bank_accounts": 0
    }
  ],
  "pagination": {
    "cursor": "a28df285-baca-47b2-aae0-e3f085a096d2"
  }
}