Skip to main content
POST
Find a person by LinkedIn profile, email, or name and company

Authorizations

Authorization
string
header
required

An API key, orbb_sk_…, created in the console; or the console’s session token. See Authentication.

Body

application/json
id
string

Looks up a person by a LinkedIn profile URL, or the public identifier from one (the part after /in/), with no search. A blank string counts as absent. Sent with any other field, on_miss included, it is answered 400 invalid_body.

A well-formed id with no known profile is answered 200 with resolution.status UNRESOLVED; one that several people have held, 200 with AMBIGUOUS. A value that is neither a profile URL nor a public identifier is answered 404 person_not_found.

A LinkedIn member token (ACoAA…) is not a public identifier: it is answered 404 person_not_found.

See also email, 422 ambiguous_person.

Maximum string length: 512
email
string

Searches for the person behind an email address. A blank string counts as absent. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body.

When the email finds no one, a web search by name follows: the name sent with it (full_name, or first_name and last_name), or one taken from the address, with any company field; the name and company also choose which current position the answer shows.

See also id, first_name, on_miss.

Maximum string length: 512
full_name
string

Searches by the person’s whole name, written First Last or Last, First; titles and degree suffixes are dropped, and with no comma the first word is the first name, the rest the last name. A blank string counts as absent. Sent with first_name or last_name, it is answered 400 invalid_body. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body.

A name of one word, or written without spaces, has no last name: send it in first_name and last_name instead. Without email or id, such a full_name is answered 400 invalid_body; beside an email it is accepted and not searched.

See also first_name, last_name, company, email.

Maximum string length: 512
first_name
string

Searches by the person’s first name, always sent with last_name, and with a company field when there is no email. A blank string counts as absent. Sent without last_name, or with full_name, it is answered 400 invalid_body. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body.

See also last_name, company, email.

Maximum string length: 512
last_name
string

Searches by the person’s last name, always sent with first_name, and with a company field when there is no email. A blank string counts as absent. Sent without first_name, or with full_name, it is answered 400 invalid_body. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body.

See also first_name, company, email.

Maximum string length: 512
company
string

Names the person’s company, as it is usually written. A blank string counts as absent. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body. The company also chooses which current position the answer shows.

See also first_name, email.

Maximum string length: 512
company_domain
string

Names the web domain of the person’s company, such as acme.com. A blank string counts as absent. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body.

A work email’s domain is used as a company domain too; a personal address’s is not.

See also company, email.

Maximum string length: 512
company_linkedin_url
string

Names the LinkedIn page of the person’s company: a company, school or showcase page (linkedin.com/company/…, /school/…, /showcase/…); any other URL is answered 400 invalid_body. A blank string counts as absent. Without email or id, the body needs a name (full_name, or first_name and last_name) and a company field (company, company_domain or company_linkedin_url); any other body is answered 400 invalid_body.

See also company.

Maximum string length: 512
on_miss
enum<string>

Sets how far the search goes. UNKNOWN searches the profiles already known and public web pages; RESEARCH also queries a further profile source, and does not reuse an earlier search for the same person that found no one. Any other value, or on_miss sent with id, is answered 400 invalid_body.

A resolve takes no max_tokens.

See also /v1/job, Billing, Rate limits.

Default: UNKNOWN.

Available options:
UNKNOWN,
RESEARCH

Response

Whether, and how, the person was identified; the person, when RESOLVED.

resolution
object

Whether, and how, the person was identified. Present in every resolve 200; a body with job only is a job answer.

person
object

The person found. Present only when resolution.status is RESOLVED.

job
object

The job that searched, with status DONE. Absent in a resolve by id.