Summary

The Business Summary action provides basic information on an individual business and can include business name, company registration number, business classification, trading status and negative indicators to define if the business is closed or is about to close unfavourably.

This action can be used to retrieve information about a business by providing their business MatchId and a valid x-investigation-token.

To use this action, you first need to make a Business Match request to retrieve an InvestigationToken and a MatchId for the business you are interested in.

You can then use this business MatchId and x-investigation-token to make additional requests to the Summary action.

Service Request

To request for a Deceased Register, add SUMMARY action to the request body entity BusinessesDetailsActionsRequest:

{
    "actions": [
      {
        "action": "SUMMARY"
      }
    ],
    "matchId": "B_000000000"
}

	Array of objects (PeopleDetailsAction)
matchId	string (MatchId) Identifier of a matched person, business or address that can then be used to request more details of the match.
tags	Array of strings Free text tags for tracking purposes.

{

• "actions": [

  • {

    • "action": "SUMMARY"

    }

  ],
• "matchId": "P_1955F18491918",
• "tags": [

  • "CASE_NUMBER=123",
  • "IMPORTANT"

  ]

}

A valid x-investigation-token header must be included in the request.

Service Response

The Summary action returns a JSON object containing information about the business included in BusinessesDetailsActionsResponse's summary property.

object (DeceasedRegister)

{

• "deceasedRegister": {

  • "firstName": "string",
  • "middleNames": [

    • "James"

    ],
  • "lastNames": [

    • "Smith"

    ],
  • "alias": "Jonny",
  • "maidenName": "Hunter",
  • "address": {

    • "premise": "128",
    • "building": "string",
    • "subBuilding": "string",
    • "thoroughfare": "Queen Victoria Street",
    • "locality": "London",
    • "postalCode": "EC4V 4BJ",
    • "country": "GBR"

    },
  • "source": "Deceased Register",
  • "dateOfBirth": {

    • "day": 31,
    • "month": 12,
    • "year": 1981

    },
  • "dateOfDeath": {

    • "day": 31,
    • "month": 12,
    • "year": 1981

    },
  • "registrationDistrict": "Birmingham",
  • "referenceNumber": "522880000",
  • "confidenceLevel": 6,
  • "placeOfBirth": "London",
  • "isProvidedDod": true

  }

}

A standard example workflow is detailed in Details Actions page