Skip to main content
GET
Get overview
This endpoint is currently available in Sandbox only. It is not yet available in Production.
Get overview is the endpoint that provides a summary of the business user’s KYB processes. By default, only the code and status of each KYB process are included in the response. If you need detailed information, you can use the detailed query parameter to specify the KYB processes you want more detail on, which will bring their input and output fields, as well as the full list of associated persons.
Getting the detailed KYB information is more expensive in terms of performance and should be used only when necessary.

Overall status

The summary object describes the business user’s overall standing, independently of the individual processes: The accompanying reason field carries additional context for the current status, and is none when there is nothing further to report.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Query Parameters

detailed
enum<string>[]

Include detailed information about the specified KYB processes. Use this sparingly as its more expensive to retrieve.

Maximum array length: 20
Available options:
profile,
documents,
financialInstitution,
associatedPersons,
attestation

Response

KYB overview retrieved.

summary
object
required
processes
object
required