Skip to main content

Details Actions

This section covers actions for businesses-derived actions used to get further details for a previously matched business.

Business Details Actions require an active investigation. To generate an investigation token, you will need first to make a Business Match request.

Example workflow​

  1. Use the Business Match action to search for businesses:

    Example Business Match Response​
    {
      "businessMatch": {
        "matches": [
            {
                "matchId": "B_02415211",
                "business": {
                    "name": "GB GROUP PLC",
                    "registration": "02415211",
                    "classification": "SERVICES - BUSINESS SERVICES - COMPUTER SOFTWARE (DEVELOPMENT)"
                },
                "addresses": [
                    {
                        "building": "THE FOUNDATION",
                        "thoroughfare": "HERONS WAY",
                        "locality": "CHESTER",
                        "postalCode": "CH4 9GB",
                        "country": "GB"
                    }
                ],
                "sources": [
                    {
                        "name": "Companies House",
                        "years": []
                    },
                    {
                        "name": "Land Registry Commercial",
                        "years": []
                    }
                ]
            }
        ],
        "meta": {
          "traceId": "00000000-0000-0000-0000-000000000000",
          "timestamp": "2023-01-01T00:00:00.000Z",
          "investigationToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwZXJzb24tbWF0Y2gtc2VydmljZSIsImV4cCI6MTY4MDA4ODY3MiwidHJhY2VJZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCIsIm1hdGNoSWRzIjpbIlBfMDAwMDAwMDAwIl19.1wN7vvVuATGoDMvYLz7EQTSy3XFfUFQ4UVeYR5eRYGs"
        }
      },
      "erroredResponses": [],
      "tags": []

    }

  2. Choose a MatchId to make subsequent requests to the business details actions:

    For LAW Users​

    You can directly make subsequent requests with the chosen MatchId, including multiple requests for different MatchIds

    For Non-LAW Users​

    Include the businessMatch.meta.investigationToken as header x-investigation-token for all subsequent requests to the business details actions. Please note that a non LAW user can only retrieve details for up to 5 matched businesses per investigation.

  3. Some details responses may return newer MatchIds and a refreshed investigationToken. These can be used to make further requests for more details. This allows for a continuous investigation where you can retrieve more and more details as they become available. For more details on how to conduct a continuous investigation, check out the Continuous Investigation page.