Continuous Investigation
In the previous sections, we discussed how the investigationToken
is used to link multiple requests within the same
investigation. This token is generated by the system and is returned in the response of the initial request that starts
the investigation.
However, the investigation process can be extended beyond the initial request. The details responses
may return newer MatchIds
and a refreshed investigationToken
. These
can be used to make further requests for more
details, allowing for a continuous investigation where you can retrieve more and more details as they become available.
Example workflow​
-
Start an Investigation: Use a Match action to search for individuals, businesses or addresses. This will generate an
investigationToken
and provide a list ofMatchIds
. -
Choose a MatchId: Choose a
MatchId
to make subsequent requests to the details actions:For LAW Users​
You can directly make subsequent requests with the chosen
MatchId
, including multiple requests for differentMatchIds
For Non-LAW Users​
Include the
investigationToken
as headerx-investigation-token
for all subsequent requests to the details actions. Please note that a non LAW user can only retrieve details for up to 5 matched entities per investigation. -
Make a Details Request: The details responses may return newer IDs and a refreshed
investigationToken
.Example Business Directors Response​
{
"directors": {
"people": [],
"businesses": [
{
"name": "GB GROUP PLC",
"id": "B_02415211",
"ccjs": [],
"closed": false,
"sources": [
{
"name": "Companies House",
"years": []
}
],
"unfavourableIndicators": [],
"appointmentType": "Director",
"dateAppointed": {
"day": 15,
"month": 2,
"year": 1996
},
"dateResigned": {
"day": 15,
"month": 2,
"year": 1996
}
}
]
},
"erroredResponses": [],
"tags": [],
"meta": {
"traceId": "feb6c9d6-8795-4184-be83-f189be832e93",
"timestamp": "2024-02-05T17:50:42.138Z",
"investigationToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJidXNpbmVzcy1kZXRhaWxzLXNlcnZpY2UiLCJleHAiOjE3MDcyNDE4NDIsCiAgImludmVzdGlnYXRpb25JZCIgOiAiIiwKICAibGlua2VkRW50aXR5SWRzIiA6ICJQX2YzOTk1NDRlYmE0OWFhNTI4NWY3Y2M1MThkMmM0OTFiYzczNmIzNDc5OTg3OGVkMGMzYzI3NDRhNzZjYjhlMmEsUF83YjExOTkzOGEyZDZlOThhZjU0ZDJhMzE2YjkxY2YwZWQxOGY4OWM4NTM4NWUyMjAwODRmZWMyYjM1ZGM5NDg5LFBfOWEyNjUyZjIzMDZjYWZjOWQyY2ZlMjExMzc3Y2YxMGM1OTc1MjljY2MzODNlNzI2ZDExMTAxNDZhOTJkMDlkYixQXzA1ZjYyNDBlOTYzNWE5Y2VkZjE3ODVkMzk4YTU2YzUxYWJkODEyZTM2MmVjYWYwZGViYjVkNTA1OTUyOWFjNDQsUF8wNWY2MjQwZTk2MzVhOWNlZGYxNzg1ZDM5OGE1NmM1MWFiZDgxMmUzNjJlY2FmMGRlYmI1ZDUwNTk1MjlhYzQ0LFBfMzEzNWQ4YmZlZWRlNjNhZDczYzBhMGRhZWIxNjYyNzA4YWU1ZTkzYTdhY2YyNWYyZTg3OGM2YjEyM2M1YjhmZSxQXzFjNjE5MmU2NWIzMzdmN2UzMjdkZTZlYjk2MzM0ZTYzOTBlMDI1M2ViZmM1ZTkzMzRiNTRhYWNmNTZjYmYyMzcsUF8xYzYxOTJlNjViMzM3ZjdlMzI3ZGU2ZWI5NjMzNGU2MzkwZTAyNTNlYmZjNWU5MzM0YjU0YWFjZjU2Y2JmMjM3LFBfMzEzNWQ4YmZlZWRlNjNhZDczYzBhMGRhZWIxNjYyNzA4YWU1ZTkzYTdhY2YyNWYyZTg3OGM2YjEyM2M1YjhmZSxQXzI1NWMzZmJmZWU1MGU1MWZhMGIxNmM3YjU1ODBkNDNmNTI2ODYxMTdiY2Q1M2U0NTFiYjE2NzczMDAwZjIxNjgsUF9lNTg1YjJmOTdhYWQ0NjMwNzg2MjlkZDBkODlkZmY4NDk3MjQ5NTc0MzczN2ZiNGViYmFmMDBlNGM0MGQzOGExLFBfNmM2NjM3NWIzMmVjODAyMmZhYmNlYjI1NWFkNzY2YmMyNmM2OTRmOGNjMzBmM2Q5MWJiNWRiYjQ0MWVmZTg2NixQXzZjNjYzNzViMzJlYzgwMjJmYWJjZWIyNTVhZDc2NmJjMjZjNjk0ZjhjYzMwZjNkOTFiYjVkYmI0NDFlZmU4NjYsUF9iZGJmYTM1MjA2MzAzYzdiNDRiMjU3YmU4YTI2MjUwOGZjZTNiNWU1ZTg0YjQ0OWI4MTA5MjUxNGNmOWE2MDJmLFBfZWFmNjAyMzIxYTk5MzQ2YWNiNWE1MDNmYTU2ZTM1NzQyODQxNzZkZmViNjgwN2ZlY2VmOTJkNmUyZTRjMjc3ZCxQX2VhZjYwMjMyMWE5OTM0NmFjYjVhNTAzZmE1NmUzNTc0Mjg0MTc2ZGZlYjY4MDdmZWNlZjkyZDZlMmU0YzI3N2QsUF81MzJiOTAzZDdhMGM0NThjYzMxMzg3YjMyZTM1ZWVhOWI4OGVjNGUxNjA4YjI3NDBkZTY3OWYxMGE1NWM4YjY1LEJfMDE2NzE5MjUsQl9URU1QTEVTRUNSRVRBUklFUzEwMDMzNjg5OSIsCiAgInRyYWNlSWQiIDogImZlYjZjOWQ2LTg3OTUtNDE4NC1iZTgzLWYxODliZTgzMmU5MyIKfQ.Abl4dF3R2AcTcX3NzUzg7oujhHADteeRFJ8VTeQA3PM"
}
} -
Make Further Requests: The details response from step 3 returns a refreshed
investigationToken
and a business ID. Use these to make further requests for more details just like the previous steps:For LAW Users​
You can directly make subsequent requests with the chosen business ID:
{
"actions": [
{
"action": "SUMMARY"
}
],
"matchId": "B_02415211"
}For Non-LAW Users​
Remember to always include the refreshed
investigationToken
you got in the same response as the business ID in your requests as headerx-investigation-token
:{
"actions": [
{
"action": "SUMMARY"
}
],
"matchId": "B_02415211"
}
This process allows for a continuous investigation where you can retrieve more and more details as they become available.