> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Business Insights

> Verify a US business in GBG GO by matching its registered name, address, and tax identification number, along with an associated person.

The **Business Insights** module verifies a business rather than an individual. It matches the business name, address, and tax identification number you provide against the records held for that business entity. It also checks whether a person you provide, such as a director or shareholder, is associated with that entity.

This page documents the **Business Insights** module, including its variants, capabilities, and the result values it returns.

## Business Insights: US Taxpayer Verification

### Capabilities

The module returns the following capabilities.

#### Address match

The result of matching the provided address against the business entity's records.

| Code        | Label     | Description                                                                      |
| ----------- | --------- | -------------------------------------------------------------------------------- |
| `match`     | Match     | The address you provided matches the address held for the business entity.       |
| `mismatch`  | Mismatch  | The address you provided doesn't match the address held for the business entity. |
| `no result` | No result | The check returned no result for the address, so no comparison was made.         |

#### Associated person match

The result of matching the provided person against people associated with the business entity.

| Code        | Label     | Description                                                                                                            |
| ----------- | --------- | ---------------------------------------------------------------------------------------------------------------------- |
| `match`     | Match     | The person you provided is recorded as associated with the business entity, for example, as a director or shareholder. |
| `mismatch`  | Mismatch  | The person you provided isn't recorded as associated with the business entity.                                         |
| `no result` | No result | The check returned no result for the person, so no comparison was made.                                                |

#### Business name match

The result of matching the provided name against the business entity's registered name.

| Code        | Label     | Description                                                                     |
| ----------- | --------- | ------------------------------------------------------------------------------- |
| `match`     | Match     | The name you provided matches the registered name of the business entity.       |
| `mismatch`  | Mismatch  | The name you provided doesn't match the registered name of the business entity. |
| `no result` | No result | The check returned no result for the business name, so no comparison was made.  |

#### Tax Id matches

The result of matching the provided tax identification number against the business entity's records.

| Code            | Label         | Description                                                                                       |
| --------------- | ------------- | ------------------------------------------------------------------------------------------------- |
| `match`         | Match         | The tax identification number you provided matches the number held for the business entity.       |
| `mismatch`      | Mismatch      | The tax identification number you provided doesn't match the number held for the business entity. |
| `not available` | Not available | No tax identification number is held for the business entity, so the check couldn't compare one.  |
| `no result`     | No result     | The check returned no result for the tax identification number, so no comparison was made.        |

### Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

| Outcome                  | Condition                                                   | Description                                                                         |
| ------------------------ | ----------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Business Match`         | Address match is `match` and business name match is `match` | Both the name and the address match the records held for the business entity.       |
| `Business Partial Match` | Business name match is `match`                              | The name matches the records held for the business entity, but the address doesn't. |
| `Business Mismatch`      | Default, when no conditions matched                         | Neither the name nor the address matches the records held for the business entity.  |
| `Error`                  | An error prevented the check                                | The module couldn't return a result.                                                |

### Input payload

The following is a sample payload used to submit data to the **US Taxpayer Verification** module for processing.

```json JSON theme={null}
{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "entities": [
        {
          "name": "Match Corp",
          "aliases": [
            "Match Corporation",
            "Match Holdings"
          ],
          "addresses": [
            {
              "administrativeArea": "Good",
              "superAdministrativeArea": "Super",
              "locality": "The Good place",
              "thoroughfare": "Goodison Park",
              "postalCode": "111111"
            }
          ],
          "taxIdentifiers": [
            {
              "type": "TIN",
              "value": "111111111"
            }
          ],
          "persons": [
            {
              "firstName": "Good",
              "lastNames": [
                "Match"
              ],
              "role": "shareholder"
            }
          ]
        }
      ]
    }
  }
}
```

| Field            | Required | Description                                                                                                       |
| ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `entities`       | Yes      | Accepts at least one item. Each item represents a business entity to verify.                                      |
| `name`           | Yes      | The registered name of the business entity.                                                                       |
| `aliases`        | No       | Any other names the business entity trades under.                                                                 |
| `addresses`      | No       | The registered or trading address of the business entity.                                                         |
| `taxIdentifiers` | No       | The tax identification number of the business entity, with its `type` and `value`.                                |
| `persons`        | No       | A person associated with the business entity, with their name and `role`, for example, a director or shareholder. |
| `PrimaryEntity`  | Yes      | The primary business entity to verify.                                                                            |
| `EntityPerson`   | No       | A person associated with the business entity, such as a director or officer.                                      |
| `EntityAddress`  | No       | The registered or trading address of the business entity.                                                         |
| `EntityTin`      | No       | The tax identification number of the business entity.                                                             |

### Sample response

The following is a sample response returned by the module.

```json JSON theme={null}
{
  "response": {
    "outcome": "Business Match",
    "advice": {}
  }
}
```