Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Open Banking

Upload Open Banking Data (Plaid Assets Report)

Uploads open banking data in the format of a Plaid Asset Report to an Inscribe customer. Once the request is received, the open banking 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/plaid_asset_report

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Request body

warningsobject[] required

A list of errors relating to the Asset Report generation.

request_idstring required

A unique identifier for the request.

Example request

{
  "report": {
    "asset_report_id": "Lr7b1341-1n67-T4a5-pl0r-493199h1vahm",
    "client_report_id": "example_client_report_101",
    "date_generated": "2022-09-21T02:45:13Z",
    "days_requested": 10,
    "user": {},
    "items": []
  },
  "warnings": [],
  "request_id": "TYeVrpGv4LDWXA2"
}

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
}