/people/by-phone

POST /api/people/by-phone

Price: 100 credits

Resolve a person (and the company they work at) from a phone number.

How to use it

The mirror of phones/find. For lawful B2B use only. What comes back is the person's name and their employer — there is no LinkedIn profile URL, job title, headline or email for the person, so a caller needing those must take the name onward to emails/find or a LinkedIn search. A number resolved before is answered from the result already established for it, up to a year old, so the employer may have changed.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• phone string required — Phone number in international format, with the country code. Example: +14155552671. Spaces, dashes, dots, a leading 00 and a trunk zero written in brackets (+44 (0)20 7183 8750) are all accepted; a digit is never otherwise added or removed, so an Italian +39 0172 693347 keeps its zero. A national number with no country code is refused. The number is echoed back in the response's `phone` field in normalised E.164 form, which may differ from the string sent. (examples: "+14155552671")

Response

• @type string (default: "PersonByPhoneResult")
• phone string required
• full_name string nullable
• first_name string nullable
• last_name string nullable
• company_name string nullable
• company_website string nullable
• company_linkedin_url string nullable
• company_industry string nullable
• company_description string nullable
• company_employee_count integer nullable
• company_employee_range string nullable
• company_location string nullable
• resolved_by string required
• confidence number required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.