Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Open Banking

Upload Open Banking Data (Inscribe Financial Data Format) (BETA)

Uploads Open Banking Data (Inscribe Financial Data Format) to an Inscribe customer (BETA). See our guide to submitting open banking data here.

post/customers/{customer_id}/open_banking_data/inscribe_financial_data

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Request body

start_datestring date required

Refers to the beginning date of the data upload period. This should be in 'YYYY-MM-DD' format and represents the day from which the analysis will start at 00:00.

end_datetimestring date-time required

Marks the ending point of the data upload period. Unlike start_date, this must include both date and time in 'YYYY-MM-DDTHH:MM:SSZ' format, indicating the exact moment the period ends.

Example request

{
  "start_date": "2023-01-01",
  "end_datetime": "2023-01-31T23:59:59Z",
  "accounts": [
    {
      "account_name": "Checking Gold Account",
      "account_number": "123456789",
      "account_type": "PERSONAL",
      "account_subtype": "PERSONAL_CHECKING",
      "available_balance": 2500.5,
      "balance": 2500.5,
      "currency_code": "USD",
      "guid": "123e4567-e89b-12d3-a456-426614174000",
      "institution_name": "Oakwood Clearwater Bank",
      "owners": [
        {
          "address": "123 Bridge Street, Sampleton, USA",
          "name": "Alan Johnson"
        }
      ],
      "transactions": [
        {
          "amount": -100,
          "currency_code": "USD",
          "date": "2023-01-15",
          "description": "Grocery Store Payment",
          "guid": "123e4567-e89b-12d3-a456-426614174000",
          "status": "PENDING"
        }
      ]
    }
  ]
}

Response

Successfully created a new Open Banking Data.

idstring uuid

Unique identifier for the Open Banking Data.

created_atstring date-time

Time at which the Open Banking Data was created, in the format: yyyy-MM-dd'T'HH:mm:ssZ

state'PROCESSING' | 'PROCESSED' | 'ERROR_PROCESSING' | 'CORRUPT_DATA_DETECTED'

The current state of the Open Banking Data, it has the following options: PROCESSING - This Open Banking Data is still being processed. PROCESSED - This Open Banking Data has finished processing and results are available. ERROR_PROCESSING - An error occurred while processing this Open Banking Data. CORRUPT_DATA_DETECTED - This Open Banking Data was found to contain corrupted data and could not be processed.

no_of_bank_accountsinteger

The number of bank accounts present in the Open Banking Data. This value will be 0 until the data is in the PROCESSED state.

Example response

{
  "id": "0efae611-b3eb-4b84-8ed0-36f11430f5a2",
  "created_at": "2022-07-14T09:46:10.510Z",
  "state": "PROCESSED",
  "no_of_bank_accounts": 2
}