> ## 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.

<AccordionGroup>
  <Accordion title="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": {}
      }
    }
    ```
  </Accordion>

  <Accordion title="Global Business Entity Verification">
    ## Capabilities

    ### Address administrative area match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Address postal code match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Input address quality level

    A broad indicator of the input address quality

    | Value | Description              |
    | ----- | ------------------------ |
    | `1`   | Excellent Quality        |
    | `2`   | Good Quality             |
    | `3`   | Poor                     |
    | `4`   | not possible to validate |

    ### Address thoroughfare match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Incorporation date match

    | Value               | Description       |
    | ------------------- | ----------------- |
    | `match`             | match             |
    | `month level match` | month level match |
    | `year level match`  | year level match  |
    | `mismatch`          | mismatch          |
    | `not available`     | not available     |
    | `no result`         | no result         |

    ### Business is multi state operation

    | Value           | Description   |
    | --------------- | ------------- |
    | `Y`             | Y             |
    | `N`             | N             |
    | `not available` | not available |

    ### Address match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `partial match` | partial match |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Business is non profit

    | Value           | Description   |
    | --------------- | ------------- |
    | `Y`             | Y             |
    | `N`             | N             |
    | `not available` | not available |

    ### Business is active

    | Value           | Description   |
    | --------------- | ------------- |
    | `Y`             | Y             |
    | `N`             | N             |
    | `not available` | not available |

    ### Business name match

    | Detail  | Description |
    | ------- | ----------- |
    | Type    | Boolean     |
    | Default | `false`     |

    ### Address locality match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ## Input payload

    The following is a sample payload used to submit data to the **Global Business Entity Verification** module for processing.

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

    | Field                                   | Required | Description                                                                                                 |
    | --------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
    | `PrimaryEntity`                         | Yes      | The primary business entity to verify.                                                                      |
    | `PrimaryEntity/name`                    | Yes      | The registered name of the business entity.                                                                 |
    | `PrimaryEntity/aliases`                 | No       | Any other names the business entity trades under.                                                           |
    | `PrimaryEntity/businessType`            | No       | The legal form of the business entity, for example, a limited company or a partnership.                     |
    | `PrimaryEntity/status`                  | No       | The trading status of the business entity, for example, active or dissolved.                                |
    | `PrimaryEntity/description`             | No       | A free-text description of what the business entity does.                                                   |
    | `PrimaryEntity/companyNumber`           | No       | The registration number issued to the business entity by its company registry.                              |
    | `PrimaryEntity/industryClassifications` | No       | The industry classification codes assigned to the business entity, for example, SIC or NAICS codes.         |
    | `PrimaryEntity/registrations`           | No       | The registrations held by the business entity, such as its entries in national or regional registries.      |
    | `PrimaryEntity/corporateStructure`      | No       | The corporate structure of the business entity, including any parent or subsidiary relationships.           |
    | `PrimaryEntity/incorporationDate`       | No       | The date the business entity was incorporated.                                                              |
    | `PrimaryEntity/dissolutionDate`         | No       | The date the business entity was dissolved, where it is no longer trading.                                  |
    | `PrimaryEntity/phones`                  | No       | The contact phone numbers held for the business entity.                                                     |
    | `PrimaryEntity/websites`                | No       | The websites held for the business entity.                                                                  |
    | `PrimaryEntity/headcount`               | No       | The number of people the business entity employs.                                                           |
    | `PrimaryEntity/isNonProfit`             | No       | Whether the business entity is a non-profit organization.                                                   |
    | `EntityAddress`                         | Yes      | The registered or trading address of the business entity.                                                   |
    | `EntityAddress/lines`                   | No       | The full address as one or more free-form lines, used when structured address components are not available. |
    | `EntityAddress/addressString`           | No       | The full address as a single line.                                                                          |
    | `EntityAddress/premise`                 | No       | The premise (building name or number) of the business address.                                              |
    | `EntityAddress/building`                | No       | The building name or number of the business address.                                                        |
    | `EntityAddress/subBuilding`             | No       | The sub-building (for example, flat or unit) of the business address.                                       |
    | `EntityAddress/thoroughfare`            | No       | The street or thoroughfare of the business address.                                                         |
    | `EntityAddress/dependentThoroughfare`   | No       | The dependent thoroughfare (a smaller street within the thoroughfare) of the business address.              |
    | `EntityAddress/locality`                | No       | The locality (town or city) of the business address.                                                        |
    | `EntityAddress/dependentLocality`       | No       | The dependent locality (a smaller area within the locality) of the business address.                        |
    | `EntityAddress/doubleDependentLocality` | No       | The double dependent locality (a smaller area within the dependent locality) of the business address.       |
    | `EntityAddress/postalCode`              | No       | The postal or ZIP code of the business address.                                                             |
    | `EntityAddress/postBox`                 | No       | The post office box of the business address.                                                                |
    | `EntityAddress/country`                 | No       | The country of the business address.                                                                        |
    | `EntityAddress/superAdministrativeArea` | No       | The super-administrative area (a larger region above the administrative area) of the business address.      |
    | `EntityAddress/administrativeArea`      | No       | The administrative area (for example, state, province, or county) of the business address.                  |
    | `EntityAddress/subAdministrativeArea`   | No       | The sub-administrative area (a smaller region within the administrative area) of the business address.      |
    | `EntityAddress/organization`            | No       | The company or organization associated with the business address.                                           |
    | `EntityAddress/location`                | No       | The geographic location (coordinates) of the business address.                                              |
    | `UserId`                                | No       | A unique identifier for the subject within your system, used to correlate the request.                      |

    ## Sample response

    The following is a sample response returned by the module.

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

  <Accordion title="Global Business Officer Verification">
    ## Capabilities

    ### Address postal code match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Address administrative area match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Input address quality level

    A broad indicator of the input address quality

    | Value | Description              |
    | ----- | ------------------------ |
    | `1`   | Excellent Quality        |
    | `2`   | Good Quality             |
    | `3`   | Poor                     |
    | `4`   | not possible to validate |

    ### Address thoroughfare match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Address match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `partial match` | partial match |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Address locality match

    | Value           | Description   |
    | --------------- | ------------- |
    | `match`         | match         |
    | `mismatch`      | mismatch      |
    | `not available` | not available |

    ### Associated person match

    | Detail  | Description |
    | ------- | ----------- |
    | Type    | Boolean     |
    | Default | `false`     |

    ## Input payload

    The following is a sample payload used to submit data to the **Global Business Officer Verification** module for processing.

    ```json JSON theme={null}
    {
      "context": {
        "subject": {
          "entities": [
            {
              "name": "Error Co",
              "persons": [
                {
                  "currentAddress": {
                    "addressString": "Error Street, Errorton"
                  },
                  "firstName": "Error",
                  "lastNames": [
                    "Error"
                  ]
                }
              ]
            }
          ],
          "uid": "variant-test-user"
        }
      }
    }
    ```

    | Field                                         | Required | Description                                                                                                            |
    | --------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
    | `PrimaryEntity`                               | Yes      | The primary business entity to verify.                                                                                 |
    | `PrimaryEntity/name`                          | Yes      | The registered name of the business entity.                                                                            |
    | `PrimaryEntity/aliases`                       | No       | Any other names the business entity trades under.                                                                      |
    | `PrimaryEntity/businessType`                  | No       | The legal form of the business entity, for example, a limited company or a partnership.                                |
    | `PrimaryEntity/status`                        | No       | The trading status of the business entity, for example, active or dissolved.                                           |
    | `PrimaryEntity/description`                   | No       | A free-text description of what the business entity does.                                                              |
    | `PrimaryEntity/companyNumber`                 | No       | The registration number issued to the business entity by its company registry.                                         |
    | `PrimaryEntity/industryClassifications`       | No       | The industry classification codes assigned to the business entity, for example, SIC or NAICS codes.                    |
    | `PrimaryEntity/registrations`                 | No       | The registrations held by the business entity, such as its entries in national or regional registries.                 |
    | `PrimaryEntity/corporateStructure`            | No       | The corporate structure of the business entity, including any parent or subsidiary relationships.                      |
    | `PrimaryEntity/incorporationDate`             | No       | The date the business entity was incorporated.                                                                         |
    | `PrimaryEntity/dissolutionDate`               | No       | The date the business entity was dissolved, where it is no longer trading.                                             |
    | `PrimaryEntity/phones`                        | No       | The contact phone numbers held for the business entity.                                                                |
    | `PrimaryEntity/websites`                      | No       | The websites held for the business entity.                                                                             |
    | `PrimaryEntity/headcount`                     | No       | The number of people the business entity employs.                                                                      |
    | `PrimaryEntity/isNonProfit`                   | No       | Whether the business entity is a non-profit organization.                                                              |
    | `EntityPerson`                                | Yes      | A person associated with the business entity, such as a director or officer.                                           |
    | `EntityPerson/firstName`                      | Yes      | The first name of the associated person.                                                                               |
    | `EntityPerson/middleNames`                    | No       | The middle names of the associated person.                                                                             |
    | `EntityPerson/lastNames`                      | Yes      | The last names of the associated person.                                                                               |
    | `EntityPerson/title`                          | No       | The title of the associated person, for example, Mr, Ms, or Dr.                                                        |
    | `EntityPerson/lastNamesAtBirth`               | No       | The last names the associated person was given at birth, where these differ from their current last names.             |
    | `EntityPerson/role`                           | No       | The role the associated person holds in the business entity, for example, a director or shareholder.                   |
    | `EntityPerson/position`                       | No       | The position the associated person holds in the business entity.                                                       |
    | `EntityPerson/ownershipPercentage`            | No       | The percentage of the business entity the associated person owns.                                                      |
    | `EntityPerson/nationality`                    | No       | The nationality of the associated person.                                                                              |
    | `EntityPerson/dateOfBirth`                    | No       | The date of birth of the associated person.                                                                            |
    | `EntityPerson/startDate`                      | No       | The date the associated person took up their role in the business entity.                                              |
    | `EntityPerson/endDate`                        | No       | The date the associated person left their role in the business entity.                                                 |
    | `EntityPersonAddress`                         | No       | The address of the associated person.                                                                                  |
    | `EntityPersonAddress/lines`                   | No       | The full address as one or more free-form lines, used when structured address components are not available.            |
    | `EntityPersonAddress/addressString`           | No       | The full address as a single line.                                                                                     |
    | `EntityPersonAddress/premise`                 | No       | The premise (building name or number) of the address of the associated person.                                         |
    | `EntityPersonAddress/building`                | No       | The building name or number of the address of the associated person.                                                   |
    | `EntityPersonAddress/subBuilding`             | No       | The sub-building (for example, flat or unit) of the address of the associated person.                                  |
    | `EntityPersonAddress/thoroughfare`            | No       | The street or thoroughfare of the address of the associated person.                                                    |
    | `EntityPersonAddress/dependentThoroughfare`   | No       | The dependent thoroughfare (a smaller street within the thoroughfare) of the address of the associated person.         |
    | `EntityPersonAddress/locality`                | No       | The locality (town or city) of the address of the associated person.                                                   |
    | `EntityPersonAddress/dependentLocality`       | No       | The dependent locality (a smaller area within the locality) of the address of the associated person.                   |
    | `EntityPersonAddress/doubleDependentLocality` | No       | The double dependent locality (a smaller area within the dependent locality) of the address of the associated person.  |
    | `EntityPersonAddress/postalCode`              | No       | The postal or ZIP code of the address of the associated person.                                                        |
    | `EntityPersonAddress/postBox`                 | No       | The post office box of the address of the associated person.                                                           |
    | `EntityPersonAddress/country`                 | No       | The country of the address of the associated person.                                                                   |
    | `EntityPersonAddress/superAdministrativeArea` | No       | The super-administrative area (a larger region above the administrative area) of the address of the associated person. |
    | `EntityPersonAddress/administrativeArea`      | No       | The administrative area (for example, state, province, or county) of the address of the associated person.             |
    | `EntityPersonAddress/subAdministrativeArea`   | No       | The sub-administrative area (a smaller region within the administrative area) of the address of the associated person. |
    | `EntityPersonAddress/organization`            | No       | The company or organization associated with the address of the associated person.                                      |
    | `EntityPersonAddress/location`                | No       | The geographic location (coordinates) of the address of the associated person.                                         |
    | `UserId`                                      | No       | A unique identifier for the subject within your system, used to correlate the request.                                 |

    ## Sample response

    The following is a sample response returned by the module.

    ```json JSON theme={null}
    {
      "response": {
        "advice": {},
        "outcome": "Error"
      }
    }
    ```
  </Accordion>
</AccordionGroup>
