Start a phone enrichment

curl --request POST \
  --url https://client-api.salesfinity.co/v1/api/enrichment/phone \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "linkedin_url": "https://www.linkedin.com/in/username",
  "callback_url": "https://example.com/webhooks/enrichment",
  "external_id": "lead-42"
}
'

import requests

url = "https://client-api.salesfinity.co/v1/api/enrichment/phone"

payload = {
    "linkedin_url": "https://www.linkedin.com/in/username",
    "callback_url": "https://example.com/webhooks/enrichment",
    "external_id": "lead-42"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    linkedin_url: 'https://www.linkedin.com/in/username',
    callback_url: 'https://example.com/webhooks/enrichment',
    external_id: 'lead-42'
  })
};

fetch('https://client-api.salesfinity.co/v1/api/enrichment/phone', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v1/api/enrichment/phone",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'linkedin_url' => 'https://www.linkedin.com/in/username',
    'callback_url' => 'https://example.com/webhooks/enrichment',
    'external_id' => 'lead-42'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v1/api/enrichment/phone"

	payload := strings.NewReader("{\n  \"linkedin_url\": \"https://www.linkedin.com/in/username\",\n  \"callback_url\": \"https://example.com/webhooks/enrichment\",\n  \"external_id\": \"lead-42\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://client-api.salesfinity.co/v1/api/enrichment/phone")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"linkedin_url\": \"https://www.linkedin.com/in/username\",\n  \"callback_url\": \"https://example.com/webhooks/enrichment\",\n  \"external_id\": \"lead-42\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/api/enrichment/phone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"linkedin_url\": \"https://www.linkedin.com/in/username\",\n  \"callback_url\": \"https://example.com/webhooks/enrichment\",\n  \"external_id\": \"lead-42\"\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "507f1f77bcf86cd799439011",
  "status": "pending",
  "linkedin": "https://www.linkedin.com/in/username",
  "linkedin_username": "username",
  "enrichment_type": "contact",
  "phone_numbers": [
    {
      "number": "+14155550123",
      "country_code": "US",
      "type": "mobile",
      "extension": "",
      "source": "prospeo",
      "validation": {
        "phone_number": "+14155550123",
        "is_valid": true,
        "carrier": "AT&T",
        "line_type": "mobile",
        "likely_to_answer": "P1",
        "score": 92,
        "status": "pending"
      }
    }
  ],
  "createdAt": "2026-08-27T10:15:04.221Z",
  "updatedAt": "2026-08-27T10:16:38.904Z"
}

{
  "message": [
    "limit must not be greater than 100"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Insufficient enrichment credits",
  "error": "Payment Required",
  "statusCode": 402
}

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

{
  "message": "Too many requests",
  "error": "Too Many Requests",
  "statusCode": 429
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500
}

Enrichment

Request a Phone Enrichment

Starts an asynchronous lookup of mobile and direct-dial phone numbers for a LinkedIn profile. Returns immediately with a request _id and a status of pending; a provider waterfall then runs in the background, validating each candidate number and completing on the first one that clears validation. The result is delivered either by polling GET /v1/api/enrichment/phone/{id} or via the optional callback_url webhook. A completed lookup that returns at least one number costs 1 enrichment credit; a completed lookup with an empty list, and every not-found result, are free. Phone and email enrichment share one credit pool, and a positive balance is required.

POST

api

enrichment

phone

Start a phone enrichment

curl --request POST \
  --url https://client-api.salesfinity.co/v1/api/enrichment/phone \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "linkedin_url": "https://www.linkedin.com/in/username",
  "callback_url": "https://example.com/webhooks/enrichment",
  "external_id": "lead-42"
}
'

import requests

url = "https://client-api.salesfinity.co/v1/api/enrichment/phone"

payload = {
    "linkedin_url": "https://www.linkedin.com/in/username",
    "callback_url": "https://example.com/webhooks/enrichment",
    "external_id": "lead-42"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    linkedin_url: 'https://www.linkedin.com/in/username',
    callback_url: 'https://example.com/webhooks/enrichment',
    external_id: 'lead-42'
  })
};

fetch('https://client-api.salesfinity.co/v1/api/enrichment/phone', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v1/api/enrichment/phone",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'linkedin_url' => 'https://www.linkedin.com/in/username',
    'callback_url' => 'https://example.com/webhooks/enrichment',
    'external_id' => 'lead-42'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v1/api/enrichment/phone"

	payload := strings.NewReader("{\n  \"linkedin_url\": \"https://www.linkedin.com/in/username\",\n  \"callback_url\": \"https://example.com/webhooks/enrichment\",\n  \"external_id\": \"lead-42\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://client-api.salesfinity.co/v1/api/enrichment/phone")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"linkedin_url\": \"https://www.linkedin.com/in/username\",\n  \"callback_url\": \"https://example.com/webhooks/enrichment\",\n  \"external_id\": \"lead-42\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/api/enrichment/phone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"linkedin_url\": \"https://www.linkedin.com/in/username\",\n  \"callback_url\": \"https://example.com/webhooks/enrichment\",\n  \"external_id\": \"lead-42\"\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "507f1f77bcf86cd799439011",
  "status": "pending",
  "linkedin": "https://www.linkedin.com/in/username",
  "linkedin_username": "username",
  "enrichment_type": "contact",
  "phone_numbers": [
    {
      "number": "+14155550123",
      "country_code": "US",
      "type": "mobile",
      "extension": "",
      "source": "prospeo",
      "validation": {
        "phone_number": "+14155550123",
        "is_valid": true,
        "carrier": "AT&T",
        "line_type": "mobile",
        "likely_to_answer": "P1",
        "score": 92,
        "status": "pending"
      }
    }
  ],
  "createdAt": "2026-08-27T10:15:04.221Z",
  "updatedAt": "2026-08-27T10:16:38.904Z"
}

{
  "message": [
    "limit must not be greater than 100"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Insufficient enrichment credits",
  "error": "Payment Required",
  "statusCode": 402
}

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

{
  "message": "Too many requests",
  "error": "Too Many Requests",
  "statusCode": 429
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500
}

Starts an asynchronous lookup of mobile and direct-dial phone numbers for a LinkedIn profile. The call returns immediately with a request _id and a status of pending. Behind it runs a provider waterfall: each data provider in turn is asked for a number, every candidate is validated, and the request completes on the first number that clears validation. Collect the result either by polling the returned _id, or by providing a callback_url that we POST to when the lookup finishes.

Each completed lookup that returns at least one number costs 1 enrichment credit. A completed result with an empty phone_numbers list, and every not-found result, are free. Phone and email enrichment draw on the same credit pool — check the balance with Get Enrichment Credits. The request is rejected with 402 if the team has no remaining credits.

Request Body

Field	Type	Required	Description
`linkedin_url`	string	Yes	LinkedIn profile URL. Must be a `linkedin.com/in/<username>` URL.
`callback_url`	string (URL)	No	Webhook POSTed when the enrichment finishes. Retried up to 3 times with backoff.
`external_id`	string (≤256)	No	Opaque value echoed back in the callback for client-side correlation.

Example Request

{
  "linkedin_url": "https://www.linkedin.com/in/janedoe",
  "callback_url": "https://example.com/webhooks/enrichment",
  "external_id": "lead-42"
}

Response (201)

{
  "_id": "507f1f77bcf86cd799439011",
  "linkedin": "https://www.linkedin.com/in/janedoe",
  "linkedin_username": "janedoe",
  "status": "pending",
  "enrichment_type": "contact",
  "createdAt": "2026-08-27T10:15:04.221Z",
  "updatedAt": "2026-08-27T10:15:04.221Z"
}

Persist the _id — it is the handle for polling and the identifier referenced in the callback as request_id.

external_id is held against your request and returned in the callback only. It is not echoed in this response, nor in the polling response.

Callback payload

If you supplied a callback_url, we POST a JSON body to it once the lookup resolves:

{
  "request_id": "507f1f77bcf86cd799439011",
  "status": "completed",
  "enrichment_type": "contact",
  "contact": {
    "linkedin_username": "janedoe",
    "phone_numbers": [
      {
        "number": "+14155550123",
        "country_code": "US",
        "type": "mobile",
        "extension": "",
        "source": "prospeo",
        "validation": {
          "phone_number": "+14155550123",
          "is_valid": true,
          "carrier": "AT&T",
          "line_type": "mobile",
          "likely_to_answer": "P1",
          "score": 92,
          "status": "completed"
        }
      }
    ]
  },
  "linkedin_url": "https://www.linkedin.com/in/janedoe",
  "external_id": "lead-42"
}

Note the shape difference from polling: the callback nests the numbers under contact, while the poll response returns phone_numbers at the top level. status is either completed or not-found — a phone enrichment never calls back with failed. On not-found, contact is usually null; when the profile is known but no provider was eligible to be queried, contact is present with the numbers already on file. Delivery is attempted up to 3 times with backoff; if every attempt fails, fall back to polling.

Errors

Status	Description
400	Validation failed — `linkedin_url` is not a `linkedin.com/in/<username>` URL
402	Insufficient enrichment credits

Authorizations

x-api-key

string

header

required

Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.

Body

application/json

linkedin_url

string

required

LinkedIn profile URL. Must be a linkedin.com/in/ URL.

Example:

"https://www.linkedin.com/in/username"

callback_url

string<uri>

Optional. Webhook URL POSTed when the enrichment finishes. Retried up to 3 times.

Example:

"https://example.com/webhooks/enrichment"

external_id

string

Optional. Echoed back in the callback payload for client-side correlation. It is not returned by this endpoint or by the polling endpoint.

Maximum string length: 256

Example:

"lead-42"

Response

Enrichment request accepted. Poll the returned _id, or wait for the callback.

_id

string

Enrichment request ID. Use this to poll GET /v1/api/enrichment/phone/{id}, and to match the request_id in the callback.

Example:

"507f1f77bcf86cd799439011"

status

enum<string>

Current state of the request. completed means the waterfall finished; not-found means no number passed validation. Phone enrichment never resolves to failed.

Available options:

pending,

processing,

completed,

not-found

string

The LinkedIn profile URL the request was created with.

Example:

"https://www.linkedin.com/in/username"

linkedin_username

string

The username extracted from the LinkedIn URL.

Example:

"username"

enrichment_type

enum<string>

Always contact for phone enrichment.

Available options:

contact

phone_numbers

object[]

Every number held for the profile, not only the ones this request discovered. Populated only when status is completed; an empty array otherwise. Absent from the response to POST /v1/api/enrichment/phone.

Show child attributes

createdAt

string<date-time>

Example:

"2026-08-27T10:15:04.221Z"

updatedAt

string<date-time>

Example:

"2026-08-27T10:16:38.904Z"

API Documentation

Contact Lists

Notes

Enrichment

Team & Call Logs

Scored Calls

Dispositions

Sequences

Snoozed Contacts

Follow-up Tasks

Custom Fields

Analytics

Request a Phone Enrichment

Request Body

Example Request

Response (201)

Callback payload

Errors

Authorizations

Body

Response

​Request Body

​Example Request

​Response (201)

​Callback payload

​Errors

Authorizations

Body

Response

Request Body

Example Request

Response (201)

Callback payload

Errors