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.

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

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

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

Service Request

To request for a Person Summary, add SUMMARY action to the request body entity PeopleDetailsActionsRequest:

{
    "actions": [
      {
        "action": "SUMMARY"
      }
    ],
    "matchId": "P_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 person included in PeopleDetailsActionsResponse's summary property.

	object (PersonSummary) Person format used across the Investigate API
	object (PersonAddresses)
	object (DeceasedRegisterActionResponse)
	object (InsolvencyActionResponse)
	Array of objects (ErroredResponses)
tags	Array of strings Free text tags used for tracking purposes, they will be included in response.
	object (Meta) Metadata describing the response produced.

{"summary": {"firstName": "string",
"middleNames": ["James"
],
"lastNames": ["Smith"
],
"dateOfBirth": {"day": 31,
"month": 12,
"year": 1981
},
"id": "P_1955F18491918",
"gender": "string",
"sources": [{"name": "string",
"years": [2018
]
}
],
"unfavourableIndicators": [{"indicator": "HAS_INSOLVENCY_RECORD"
}
],
"disqualifications": [{"startDate": {"day": 31,
"month": 12,
"year": 1981
},
"endDate": {"day": 31,
"month": 12,
"year": 1981
}
}
],
"role": ["string"
],
"address": {"premise": "128",
"building": "string",
"subBuilding": "string",
"thoroughfare": "Queen Victoria Street",
"locality": "London",
"postalCode": "EC4V 4BJ",
"country": "GBR"
}
},
"addresses": {"addresses": [{"premise": "128",
"building": "string",
"subBuilding": "string",
"thoroughfare": "Queen Victoria Street",
"locality": "London",
"postalCode": "EC4V 4BJ",
"country": "GBR",
"id": "P_1955F18491918",
"isOverseas": true,
"sources": [{"name": "string",
"years": [2018
]
}
]
}
]
},
"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
}
},
"insolvency": {"insolvency": {"firstName": "string",
"middleNames": ["James"
],
"lastNames": ["Smith"
],
"alias": "Jonny",
"address": {"premise": "128",
"building": "string",
"subBuilding": "string",
"thoroughfare": "Queen Victoria Street",
"locality": "London",
"postalCode": "EC4V 4BJ",
"country": "GBR"
},
"dateOfBirth": {"day": 31,
"month": 12,
"year": 1981
},
"dateOfDeath": {"day": 31,
"month": 12,
"year": 1981
},
"occupation": "string",
"orderType": "IVA",
"court": "OFFICE OF THE ADJUDICATOR",
"courtNumber": "0010743",
"caseNumber": "5093922",
"caseYear": "2010",
"startDate": {"day": 31,
"month": 12,
"year": 1981
},
"endDate": {"day": 31,
"month": 12,
"year": 1981
},
"status": "CURRENT",
"caseDescription": "string",
"practitioner": "string"
}
},
"erroredResponses": [{"errors": [{"location": "string",
"code": 0,
"problem": "string",
"action": "string"
}
],
"meta": {"traceId": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
"timestamp": "2019-01-04T14:38:25Z",
"investigationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFjZUlkIjoiMTIzNDU2IiwibWF0Y2hJZHMiOltdLCJleHAiOjE1MTYyMzkwMjJ9.3SZoV56G0HT289QqP04OT5F1ITtsMqRCGkPok2-st50"
}
}
],
"tags": ["CASE_NUMBER=123",
"IMPORTANT"
],
"meta": {"traceId": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
"timestamp": "2019-01-04T14:38:25Z",
"investigationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFjZUlkIjoiMTIzNDU2IiwibWF0Y2hJZHMiOltdLCJleHAiOjE1MTYyMzkwMjJ9.3SZoV56G0HT289QqP04OT5F1ITtsMqRCGkPok2-st50"
}
}

Summary

Service Request​

Service Response​

A standard example workflow is detailed in Details Actions page​

Service Request

Service Response

A standard example workflow is detailed in Details Actions page