Skip to main content

KYC Suite API FAQ

Answers to questions related to the KYC Suite API

Pieter Reitsma avatar
Written by Pieter Reitsma
Updated over 3 years ago

This page lists questions and answers, some with detailed instructions.

Contents

What is this user-id starting with eu-central-1?

Some of our fields containing a user-id are returned including a prefix. This prefix is valuable for us, because it determines in which user-pool the user is located.

"{locationCode}_{userPool}||{userId}"

Example:

"updatedBy": "eu-central-1_A8rHQrA94||01010101-0101-0101-0101-010101010101"

I only have a user-id, how do I get the name for this user?

Because of security and performance reasons, we typically only provide a user-id in our responses. To get the name of the user, you could request the list of active users and then selecting the information you need.

To list all users active, you can use the REST endpoint:

GET https://api.blanco-acc.cloud/access/users/active

This array will retrieve an array of objects:

[{
"tenant_id":"tenantId",
"lastName":"lastName",
"userName":"userName",
"_id":"userId",
"createdAt":"createdAtTimestamp",
"firstName":"firstName"
}]

The field _id will contain the user-id which can be used to match with the user-id you have.

What are the possible statuses of the registration object?

You can read more on that on this page: Registration status

Could I have some more information on what the identification object looks like?

Absolutely, you can find some examples on this page: Registration Identifications

How can I list all parties in the Client File?

You could use the GraphQL query PartiesList. For more information, check out this page: API Endpoints for Client File

Do you have any documentation on your API?

We have multiple endpoints. For the GraphQL endpoints you can use our GraphiQL interface to explore the query options. For more on this, see: API Endpoints for Client File

We are still working on updating our REST API documentation and presenting them in a secure manner. Feel free to request anything you might need.

Did this answer your question?