Skip to main content
POST
Check contact identifiers

Authorizations

Authorization
string
header
required

JWT authentication token

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Body

application/json
email
string

Email to check. Only counts as an identifier if it contains "@".

linkedin_identifier
string

LinkedIn profile URL or just the profile name.

phone_number
string

Phone (area code + number, without the country code). A phone that doesn't form a valid number is ignored in the check.

country_code
string

Phone country calling code. Example: 55.

exclude_contact_id
string

Contact to ignore in the check. The edit form sends the contact itself: a value equal to its own isn't a conflict.

Pattern: ^[0-9a-fA-F]{24}$

Response

200 - application/json

Check result

status
enum<string>
required

new: no contact has the identifiers. existing: the POST would reuse contact. conflict: different identifiers point to different contacts.

Available options:
new,
existing,
conflict
matched_by
enum<string> | null
required

Identifier that matched

Available options:
email,
linkedin,
phone
matches_count
number
required

How many contacts in the company matched by the matched_by key.

contact
object | null
required

Contact that would be reused. null for new and conflict.

conflicts
object[]
required

For conflict, the contact for each identifier. Empty in the other cases.