Background Check V2

Background Check V2 is an improvement over Background Check by adding beneficial owners and the compliance of each entity.

To verify the compliance of each entity, you need to enable the background_check_nodes_check setting. To verify only the compliance of officers or beneficial owners, you need to enable the officers_check and beneficial_owners_check settings respectively from the provider ComplyCube.

Field	Type	Description
acceptable	string	OK if it is acceptable NOK if it is risky
reasons	string[]	A list of risks found during the background check, each element can be one of: BENEFICIAL_OWNER_BLACKLISTED: One or more beneficial owners are people blacklisted by the authorities BENEFICIAL_OWNER_NATIONALITY_BLACKLISTED: One or more beneficial owners have the nationality of a blacklisted country COMPANY_ADDRESS_BLACKLISTED: The company is headquartered in a blacklisted country MANAGEMENT_DIFFICULTIES: The company being studied has had management difficulties, in the past or ongoing, leading to collective procedures FINANCIAL_DIFFICULTIES: The company being studied has had financial difficulties, in the past or ongoing, leading to collective procedures RELATED_MANAGEMENT_DIFFICULTIES: One or more companies related to the company being studied has had management difficulties, in the past or ongoing, leading to collective procedures. RELATED_FINANCIAL_DIFFICULTIES: One or more companies related to the company being studied has had financial difficulties, in the past or ongoing, leading to collective procedures. CLOSED_COMPANY: The company is struck off from the trade and companies registry, or appears as closed on INSEE registries INACTIVE_COMPANY: The company is inactive WATCHLIST Sanctions & Watchlist PEP PEP - Politically Exposed Person ADVERSE_MEDIA Adverse media OTHER_LISTS Other prudent lists
warnings	string[]	A list of warnings found during the background check, each element can be one of: BENEFICIAL_OWNERS_UNAVAILABLE: The BackgroundCheck was carried out despite failing to obtain the list of beneficial owners due to the 'require_beneficial_owners_check' setting provider BENEFICIAL_OWNERS_EMPTY: The company has no Beneficial owners
ratio	float	The ratio of collective procedures
details	Details	List of nodes and links showing the relationship of the company's officers

Details

Field	Type	Description
nodes	array of Node	List of nodes.
links	array of Link	List of links.

Node

Nodes are entities of the relationship graph of your user. They represent companies and their officers (both legal and natural).

Field	Type	Description
id	string	Identifier of officer.
siren	string	Siren of the officer if it is a LEGAL person.
name	string	Name of the officer if it is a LEGAL person.
first_name	string	First name of the officer if it is a NATURAL person.
last_name	string	Last name of the officer if it is a NATURAL person.
birth_date	datetime	Date of birth of the officer, if it is a NATURAL person.
type	string	Type of officer, can be either LEGAL or NATURAL
pcl	Pcl	Collective procedures indicators
file_id	string	See Conformity file identifier

Link

Field	Type	Description
from	string	Identifier node of subsidiary.
to	string	Identifier node of the officer.
role	string	Name of the position held by the officer.
parts	string	Parts held by the beneficial owner.
votes	string	Votes held by the beneficial owner.
start_date	datetime	Date from which the position held by the officer started.
end_date	datetime	Date on which the position held by the officer ended.

Pcl

Field	Type	Description
management_difficulties	bool	Will be true if the officer or company has had management difficulties, and false otherwise
financial_difficulties	bool	Will be true if the officer or company has had financial difficulties., and false otherwise

Endpoints

GET /api/v6/users/{userId}/background-check-v2?active=0&executive=0

This endpoint retrieves the background check of a user, listing all the roles of the officers and beneficial owners related to the company.

The endpoint provides two options to filter officers and beneficial owners:

1- active: Displays only officers and beneficial owners who have at least one active role.

2- executive: Displays only officers who have at least one executive role. And all beneficial owners.

GET /api/v6/users/{userId}/background-check-v2?active=1&executive=1

Note Both options are enabled (true) by default. If you don’t specify both options in the endpoint, it is equivalent to ?active=1&executive=1.