Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Open Banking

Upload Open Banking Data (MX Aggregated Data)

Uploads MX Aggregated Data to an Inscribe customer. MX Aggregated Data is a format made by combining the responses from various MX endpoint requests. Once the request is received, the MX Aggregated Data will be processed by Inscribe’s Credit Insights service. See our guide to submitting open banking data here.

post/customers/{customer_id}/open_banking_data/mx_aggregated_data

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Request body

from_datestring date required

The from_date parameter that was used when querying the MX List Transactions resource.

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
}