Advanced search capacity integration

This is page documentation is about the advanced search capacity for Sis Inside API. Objects details in the API documentation

About

The company identification capacity used in Sis ID products for control or invitation is extended with additional and optional search parameters.

These parameters are used by Sis ID to improve company identification success against third party data providers and should prove especially relevant to verifications of third parties in countries like US, Canada or Germany (non exhaustive) to fix limitations documented in:

• Country specificities and workaround solutions

• The particularities of company identification in the United States, The particularities of company identification in Canada or The particularities of company identification in Germany

When to use advanced search in API products

The advanced search feature applies to company identification across all countries and should be used:

• When company identification fail with explicit reasons like Company unknown or Too many companies found

• Without limitations of specific countries

• To improve controls using a registration ID. It does not apply to controls by name

Using this capacity does not require option, permission or pricing increase.
 

Search behavior and matching logic

The search mechanism relies on proximity-based matching. Results are selected based on how closely the provided search parameters align with the stored company data.
Adding relevant parameters improves matching accuracy, while adding incorrect or conflicting parameters degrades matching efficiency and may prevent a result from being returned.

Because some identifiers (such as registrationId) are not unique within a country, advanced search criteria may be required to uniquely identify a company.

Example

Existing company record

• country: US

• registrationId: 123456789

• city: Mandeville

• zipCode: 70471

• state: Louisiana (LA)

Since registrationId = 123456789 is not unique among US companies, additional parameters are required to correctly identify this company.

Successful searches

The following searches return the company because the parameters are sufficiently close to the stored data:

• registrationId = 123456789, country = US, city = Mandeville

• registrationId = 123456789, country = US, city = Mandeville, zipCode = 99999

• registrationId = 123456789, country = US, city = Damneville
  (minor city name deviation still matches by proximity)

Unsuccessful searches

The following searches do not return the company due to low proximity or conflicting parameters:

• registrationId = 123456789, country = US, city = AnyCityName

• registrationId = 123456789, country = US, city = Mandeville, zipCode = 99999, companyName = AnyName
  (incorrect company name reduces overall match score below the threshold)

Advanced search criteria

The following search criteria can thus be appended to the entity / company objects for legal entity verification:

• name

• streetAddress

• postalCode

• city

ℹ️ Search criteria properties naming can vary from an API to another due to properties preexistence constraints. Please refer to DTO sections of the API documentation for more details

What changes for existing integrations

{
    "entity": {
        "company": {
            "countryCode": "string",
            "registrationId": "string",
            "name": "string",  //EXISTING
            "address": {
                "streetAddress": "string",      //NEW
                "postalCode": "string",  //EXISTING
                "city": "string"         //NEW
            },
        },
        "paymentIdentity": {
            "bban": "string",
            "bic": "string",
            "countryCode": "string",
            "iban": "string",
            "routingCode": "string"
        },
        "reference": "MYCOMPANY-REF-123456",
        "tags": [
            "string"
        ]
    }
}

  "input": {
        "paymentIdentity": {
            "iban": "string"
        },
        "company": {
            "countryCode": "string",
            "registrationId": "string",
            "name" : "string",
            "address": {
                "streetAddress": "string",      
                "postalCode": "string",  
                "city": "string"
            }
        }

{
    "company": {
        "countryCode": "FR",
        "companyId": "010742391",
        "name": "NVIDIA Corporation",
        "address": {
            "streetAddress": "90 STATE ST, STE 700",
            "postalCode": "12207-1707",
            "city": "ALBANY"
    }
}