Details Actions

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

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

Example workflow

1. Use the Person Match action to search for individuals:

   Example Person Match Response

   {
     "personMatch": {
       "matches": [
         {
           "matchId": "P_000000000",
           "person": {},
           "addresses": [
             {
               "country": "GB",
               "hasMortalityRecord": true
             }
           ],
           "sources": []
         },
         {
           "matchId": "P_111111111",
           "person": {},
           "addresses": [
             {
               "country": "GB",
               "hasInsolvencyRecord": true
             }
           ],
           "sources": []
         }
       ],
       "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 person 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 personMatch.meta.investigationToken as header x-investigation-token for all subsequent requests to the person details actions. Please note that a non LAW user can only retrieve details for up to 5 matched people 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.

📄️ Summary

The Person Summary action provides basic information on an individual person and can include all the personally identifiable information, their disqualifications, role and address.

📄️ Addresses

The Addresses action provides information on addresses which are or were registered to the requested person. The response includes the data sources and years when the person was known to be at that address.

📄️ Deceased Register

The Deceased Register action provides information about individuals who have passed away, including their name, date and place of death, case reference number, and other details that may be available.

📄️ Insolvency

The Insolvency action provides information about individuals who are insolvent, including their name, insolvency type, date of insolvency, and other details that may be available.

📄️ Continuous Investigation

In the previous sections, we discussed how the investigationToken is used to link multiple requests within the same