A search response may contain either a person object or a list of possible persons, depending on our confidence level that we can match your search to a single person.
Typically, a single person response will contain more data about the person than a possible person object. To pull up all the data about a possible person, you’ll need to run a search using its search pointer.
A search response contains the following top-level fields:
The HTTP status code of the response. Successful calls will be 200.
The number of sources returned in the sources array (if show_sources is not false).
The number of sources we know of that are relevant to the search.
The number of persons returned in this API response.
An internal ID that identifies the search on our systems. Useful for debugging.
A person object representing your search parameters. Useful to see how we understood your search.
The canonical way to express the match requirement you’ve sent. Useful to see how we’ve parsed your criteria.
An available_data object. A summary of the data we have for this search.
An error message explaining an error that prevented your search from being run.
An array of warning strings.
A person object containing the data about the person you are searching for—if a single person was matched to your query.
An array of person objects containing possible matches.
An array of source objects, in case you need to see where the data came from.
Metadata is prefixed with the '@' character.