This article describes how a performance friendly data dump can be retrieved from the API. Note that this feature will have to be enabled for you. If you want to use this functionality, please contact sales.

Retrieve the files

Query the GraphQL endpoint for the party service, which is: https://api.blanco.cloud/bcmd-party/graphql

To learn more about GraphQL you could visit the instructions on API Endpoints for Client File.

The GraphQL query is as follows:

query {
  getDataDump {
    date
    type
    downloadUrl
  }
}

Example response:

{
"data": {
    "getDataDump": [
      {
        "date": "Fri Jul 29 2022 05:00:52 GMT+0000 (Coordinated Universal Time)",
        "type": "parties",
        "downloadUrl": "{{signedUrl}}"
      }
      ...
    ]
  }
}

Field explanation:

date: data and time when the data was extracted
type: one of: parties, connections, workflows
downloadUrl: temporary download url for getting a json file containing the data, the urls are valid for 1 hour. To get new url, simply send a query for a new one.

You can download the file by performing a get request to the downloadUrl . Per file type, there is a separate URL, which will contain a different data set.

File contents

Each file contains a list of objects of the specified type. The structure of the contents for the parties will be very similar to what you could retrieve from the KYC Suite GraphQL partiesList. To learn more about the KYC Suite GraphQL interface, please visit the instructions on the API Endpoints for Client File.

The connections and workflows have a different structure which is similar to the structure from the KYC Suite REST API.

However, there might be slight differences between the data structure of the API and the data dump.

Get KYC data dump from API

Retrieve the files

File contents