Skip to main content
POST
JavaScript
20 Credits All Paid Plans Beta Feature

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Body

application/json

Identity clues for one person. Provide a person email, a person-profile social URL, or both first and last name with company, education, or location. All supplied clues are considered together.

social_urls
string<uri>[]
Required array length: 1 - 20 elements
name
object
email
string<email>
Maximum string length: 320
company
object
education
object[]
Required array length: 1 - 10 elements
location
object
timeoutMS
integer

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Required range: 1000 <= x <= 300000
tags
string[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

The highest-scoring candidate, including weak matches, or a not-found result when no usable candidate exists.

match
Candidate match · object
required

The highest-scoring person candidate.

key_metadata
object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.