Skip to main content

Pappers

The pappers component is a component that allows the user to search for a company by name or VAT number.

It might be used as an alternative to the BCE Search component, to search for companies in Belgium. It also allows to search for companies in other countries.

It uses the Pappers API to search for companies.

{
"pappers": {
"component": "pappers_search",
"label": "Pappers"
}
}

Options

countryCodeList

We can customize the country code list by defining the countryCodeList option. If we want to only search for companies in Belgium, we can define the countryCodeList option as ["BE"].

{
"pappers_search": {
"component": "pappers_search",
"label": "Search a company",
"placeholder": "Enter company number",
"options": {
"countryCodeList": ["BE", "FR", "DE"]
}
}
}

Available country codes:

Country CodeDescription
FRFrance
BEBelgium
DEGermany
ITItaly
ESSpain
NLNetherlands
PTPortugal
UKUnited Kingdom

fields

We can customize the fields searched by defining the fields option.

FieldDescription
officersOfficers of the company
ubosUltimate beneficial owners of the company
financialsFinancials of the company
documentsDocuments of the company
certificatesCertificates of the company
publicationsPublications of the company
establishmentsEstablishments of the company
contactsContacts of the company
{
"pappers_search": {
"component": "pappers_search",
"label": "Search a company",
"placeholder": "Enter company number",
"options": {
"fields": [
"officers",
"ubos",
"financials",
"documents",
"certificates",
"publications",
"establishments",
"contacts"
]
}
}
}

searchMode

If we want to search for a company by keyword, we can define the searchMode option as "keyword".

{
"pappers_search": {
"component": "pappers_search",
"label": "Search a company",
"placeholder": "Enter company number",
"options": {
"searchMode": "keyword"
}
}
}

To change the labels of the search button and of the clear button, we can define the text on the options :

{
"pappers_search": {
"component": "pappers_search",
"label": "Search a company",
"placeholder": "Enter company number",
"options": {
"searchMode": "keyword",
"clear": "Clear",
"search": "Search"
}
}
}

Storybook Examples

Pappers Search#

Pappers Search Only One Country#

Pappers Search With Initial Values#

Pappers Search As Keywords#

Pappers With Required#

Pappers Search With Placeholder#