This page contains some information on getting started with the KYC Suite API to retrieve information from the Client File.
Page contents
Introduction to GraphQL
The KYC Suite offers several GraphQL endpoints for you to retrieve data from. GraphQL is a query language for API's. To learn more about how you can make queries using GraphQL, see: https://graphql.org/learn/
Exploring Endpoints
The GraphQL endpoints can be explored using a graphical web interface called GraphiQL.
Party endpoint: https://api.blanco.cloud/bcmd-party/graphiql
Product endpoint: https://api.blanco.cloud/bcmd-product/graphiql
NB. Authentication is required to access these endpoints. So make sure you are logged in to the KYC Suite professional portal. You may retrieve your authentication token from your request header and provide this when accessing the GraphiQL endpoint.
Once connected to the GraphiQL interface, you will see an interface similar to this.
The left side of the screen can be used for your queries.
The right side of the screen can be used to browse through the documentation.
An example:
PartiesList
An example of retrieving all parties in the Client File of type "Legal Entity" and status "Accepted" with some details:
{
partiesList(partyType: "LE", partyStatus: "A"){
partyType
partyTypeText
status
statusText
legalEntity{
businessName
}
}
}
Asked questions
Are there any size limitations?
Yes, the output has limitation based on response size. There is no limitation on number of queried results. The number of results can be limited with the "limit" parameter. The default value for this parameter is 20.
Is there a way to get the count of parties?
No. We currently do not support a 'count' function on any of our GraphQL endpoints PartiesList.
However, we do understand the usefulness and are open to develop such a feature. This would result in in having a "count" variable inside the query results.
Please contact Customer Success if you're interested in such a feature.
Do you have any recommendation for querying bulk data?
When querying bulk data, we advise using the parameters "limit" and "offset" to query smaller portions of data at the same time. To keep the response size to a minimum, you could limit the fields to those that are strictly necessary. Ideally there should be a balance between those two criteria, for example: many fields with a small number of results, a few fields with a larger number of results.
We also request to perform programmed bulk operations outside of office hours, to minimise potential impact on performance.