Skip to main content

Business Match

The Business Match action is one of the primary services within the Investigate Open API.

This action enables you to submit available information about a data subject.

Minimum Requirements​

The BusinessMatch request requires inputs of Business Name or Company Registration and Address which are defined in: Businesses Search.

Service Request​

To request for a Business match, add a BUSINESS_MATCH action to the request body entity BusinessesActionsRequest:

{
    "actions": [
        { "action": "BUSINESS_MATCH" }
    ]
}

BusinessesActionsRequest​

Array of objects (BusinessAction)

Actions to run with the given criteria

object (Business)

Business format used across the Investigate API

object (Address)

Address format used across the Investigate API

sourceYears
Array of integers <int32> (SourceYears) [ items <int32 > ]

Years when the matching datasets stored by GBG were issued. This could support customers compliance requirements.

tags
Array of strings

Free text tags for tracking purposes

{
  • "actions": [
    ],
  • "business": {
    },
  • "address": {
    },
  • "sourceYears": [
    ],
  • "tags": [
    ]
}

Service Response​

As part of the BusinessesActionsResponse entity, the property businessMatch contains the results of the request.

BusinessMatchActionResponse​

Array of objects (BusinessMatch)

List of matched businesses

object (Meta)

Metadata describing the response produced.

{
  • "matches": [
    ],
  • "meta": {
    }
}