Person Identify API
Overview
The Person Identify API allows you to use broad search inputs to retrieve multiple records from our person dataset. In particular, this endpoint enables functionality such as searching through a single identifying attribute, such as name, email, phone number, company, school or location, in addition to using any combination of these attributes and more. The API then scores and sorts all matching records that it returns based on the strength of their association with the input parameters.
Warning: Credit UsageEach call that you make to the Person Identify API will consume one credit, regardless of the number of profiles that the API returns.
This behavior differs from that of our other APIs, which consume one credit for each profile that they return.
Use Cases
A key use case for this endpoint is building comprehensive profiles for specific individuals, such as in the areas of:
- Investigations and forensics
- Fraud risk modeling
- Identity modeling for customer onboarding and other KYC applications
How it Works
At a high level, the Person Identify API works as follows:
- You specify some characteristics about the identity that you are interested in and pass these as input parameters to the API.
- The API cleans the input parameter values and searches our Person Dataset for matching profiles using fuzzy-matching logic.
- The API returns up to 20 of the the best matching profiles in its response while ranking them by their match score.
What's Next
Please check out the following pages for more information on the Person Identify API:
| Page | Description |
|---|---|
| Quickstart | A quick hands-on introduction to the API with simple code examples. |
| Reference | Detailed descriptions of the technical specifications and usage constraints. |
| Input Parameters | In-depth explanations of the input parameters that the API supports. |
| Output Response | In-depth explanations of the output response object that the API returns. |
| Examples | A collection of functional code examples and walkthroughs that illustrate various use cases and applications of the API. |
| FAQs | Answers to commonly asked questions and other good-to-know information. |
Know someone who’d thrive building data products and helping us launch what’s next? We’d love to meet!
Check out our open roles →
Updated 11 days ago