Composite Searching
Composite search in Portugal enables clients to automate the selection of multiple services, processing verification inputs through successive data sources and returning responses from each selected service.
Example - API Requests and Responses with following services configured:
Portugal Residential Portugal Utility
{
"countryCode": "PT",
"service": [
"Portugal Residential",
"Portugal Utility"
],
"clientReference": "Your_Reference_0001",
"firstName": "João",
"lastName": "Silva",
"dateOfBirth": "01/01/1990",
"addressElement1": "Rua Augusta 100",
"addressElement3": "Lisboa",
"addressElement5": "1100-053"
}Service Responses Overview
Each service returns its own self-contained response block, ensuring modular and source-specific verification results. Consumers of this API should handle varying response structures dynamically based on the requested services.
Service Responses Element
The serviceResponses object in the API response contains verification results from one or more data sources, structured under their respective service names. Each service returns a distinct response block with service-specific data.
Structure and Behavior:
- Each key within serviceResponses corresponds to a service name, representing an individual verification source.
- Services may return data from a single source or multiple sources in a sequenced API call.
- The structure of each service response varies, with fields such as status, identityVerified, and safeHarbourScore differing between services.
- The verifications block contains service-specific boolean indicators for individual verification checks (e.g., addressElement1, dateOfBirth, firstName).
- The returnedData block provides metadata (if applicable).