Skip to main content
POST
Enrich a person

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Names this operation, so a retry with the same key and body gets the first success again, marked Idempotent-Replayed, instead of running or charging twice. A mailbox's password is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (4xx) frees the key at once, so a corrected retry runs. After a server error (5xx), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers 409 idempotency_in_progress; after that, a send or import that may already have gone out answers 409 idempotency_outcome_unknown instead of running again. 1 to 255 visible ASCII characters, such as a UUID.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$

Body

application/json
personId
string

The person's id: the id of their row from GET /v1/lists/{listId}/rows, or the id an earlier enrich or upload answered. Send it on its own.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
linkedinUrl
string

The person's LinkedIn profile URL. Send it on its own.

Maximum string length: 500
Pattern: ^(https?:\/\/)?([\w-]+\.)?linkedin\.com\/in\/[^\s/?#]+
Example:

"https://www.linkedin.com/in/ana-costa"

firstName
string

The person's first name, with companyName or companyDomain.

Required string length: 1 - 200
lastName
string

The person's last name, with companyName or companyDomain.

Required string length: 1 - 200
fullName
string

The person's full name, in place of firstName and lastName, with companyName or companyDomain.

Required string length: 1 - 400
companyName
string

The name of the company the person works at.

Required string length: 1 - 300
companyDomain
string

The website domain of the company the person works at, such as northwind.example.

Required string length: 1 - 300
find
enum<string>
default:email

What to find: a work email (the default), a phone number, or both (email_and_phone).

Available options:
email,
phone,
email_and_phone
providers
enum<string>
default:package

Where to look: package (the default) searches our own data package; waterfall searches the package, then a fixed series of further providers. A value's price depends on who found it.

Available options:
package,
waterfall

Response

The person's email addresses and phone numbers after the call, and what it found.

emails
object[]
required

Every work email address the person has whose check showed it can receive mail: valid, or catch-all (the domain accepts mail for any address, so this one could not be confirmed). Personal addresses are left out.

phones
object[]
required

Every phone number the person has, with what checking it showed.

found
object
required

What this call found that the person did not have: the values it was charged for. Empty when it found nothing new.

personId
string

The person's id in your workspace, as list rows and personIds name it. Send it as personId to enrich them again. Absent when the person could not be saved.

primaryEmail
string

The address to write to. Absent when the person has no address in emails.

primaryPhone
string

The number to call. Absent when the person has no phone number.