API — Enrichment

Get Profile or Company Details

Retrieve the full profile record for a person, or the organisation record for a company.

  • Endpoint:
    GET /v1/contact/details
  • Mode: Asynchronous — the call returns a request id with status pending, not the data.
  • Cost: 1 credit, charged only if the record actually carries data.
  • This endpoint does not return contact details — no email, no phone number. It reveals nothing about reachability; that is solely what /enrich is for.
Authorization

A valid API key is required in the request header.

  • Authorization: Bearer
    < your_api_key >
Query Parameters
  • linkedinUrl (string) [Either]
    Supply this or contactId, never both.
    Example: linkedin.com/in/qwerty
  • contactId (string) [Either]
    The contactId returned by /search.
    Example: 5f18f116e2cd24da81189ced5adcc710
  • type (string)
    Use company to resolve an organisation instead of a person.
  • webhookUrl (string)
    Delivers the finished result instead of requiring you to poll.

Example Requests:

GET /v1/contact/details?linkedinUrl=linkedin.com/in/qwerty
GET /v1/contact/details?contactId=5f18f116e2cd24da81189ced5adcc710
GET /v1/contact/details?type=company&linkedinUrl=linkedin.com/company/deepenrich
Response

200 OK – Request Accepted

  • id (string)
    – The only handle on the request. Retain it and poll GET /v1/contact/enrich?id= for the result.
  • status (string)
    pending until the worker fulfils the request.

Example Response:

{
  "message": "success",
  "id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
  "name": "John Doe",
  "status": "pending"
}
What the Delivered Payload Contains

For a person: contactId, linkedinUrl and status, followed by the stored profile record — education, experience, organisation, title, location, certifications, industry and summary.

{
  "contactId": "5f18f116e2cd24da81189ced5adcc710",
  "linkedinUrl": "linkedin.com/in/qwerty",
  "status": "completed",
  "name": "John Doe",
  "location": "San Diego County, California, United States",
  "education": [ ... ],
  "experience": [ ... ],
  "organization": { "name": "Deepenrich", "industry": "..." }
}
  • Two things to code for. The response is not a fixed schema: fields absent from the underlying record are absent from the payload, so treat every key as optional. And person values are raw source values — you receive the original text with its original casing and phrasing.

For a company, a fixed organisation block: linkedinUrl, name, about, industry, revenue, website, founded, size and location.

Errors
  • 422 Unprocessable
    "provide either 'linkedinUrl' or 'contactId', not both"
  • 422 Unprocessable
    "'linkedinUrl' or 'contactId' is required"
  • 422 Unprocessable
    "invalid linkedinUrl" — the URL could not be parsed.
  • 402 Payment Required
    "Insufficient Credits" — balance below the 1-credit cost.
  • 402 Payment Required
    "Api daily limit have been exhausted" — daily request allowance reached.

 

 

 

curl --request GET \
  --url 'https://app.deepenrich.com/api/v1/contact/details?linkedinUrl=linkedin.com/in/qwerty' \
  --header 'Authorization: Bearer YOUR_API_KEY'
import requests

url = "https://app.deepenrich.com/api/v1/contact/details?linkedinUrl=linkedin.com/in/qwerty"

headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.request("GET", url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer YOUR_API_KEY'}
};

fetch('https://app.deepenrich.com/api/v1/contact/details?linkedinUrl=linkedin.com/in/qwerty', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.deepenrich.com/api/v1/contact/details?linkedinUrl=linkedin.com/in/qwerty",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_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"
	"io/ioutil"
	"net/http"
)

func main() {

	url := "https://app.deepenrich.com/api/v1/contact/details?linkedinUrl=linkedin.com/in/qwerty"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer YOUR_API_KEY")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.deepenrich.com/api/v1/contact/details?linkedinUrl=linkedin.com/in/qwerty")
  .header("Authorization", "Bearer YOUR_API_KEY")
  .asString();
{
  "message": "success",
  "id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
  "name": "John Doe",
  "status": "pending"
}
{
  "message": "success",
  "id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
  "name": "John Doe",
  "status": "completed",
  "data": [
    {
      "contactId": "5f18f116e2cd24da81189ced5adcc710",
      "linkedinUrl": "linkedin.com/in/qwerty",
      "status": "completed",
      "name": "John Doe",
      "location": "San Diego County, California, United States",
      "education": [],
      "experience": [],
      "organization": { "name": "Deepenrich", "industry": "it services and it consulting" }
    }
  ]
}
{
  "message": "provide either 'linkedinUrl' or 'contactId', not both"
}
{
  "message": "'linkedinUrl' or 'contactId' is required"
}
{
  "message": "invalid linkedinUrl"
}
{
  "message": "Insufficient Credits"
}
{
  "message": "Api daily limit have been exhausted"
}
{
  "message": "Please provide valid api key"
}
{
  "message": "User not found"
}