API — Enrichment

Retrieve Enrichment Result

Use this endpoint to fetch the results of a completed enrichment request.

  • Important: If you’ve set up a webhook, there's no need to call this endpoint—webhooks automatically deliver results as soon as enrichment is completed.
  • Example Request:GET /enrichment/result/{enrichment_id}
  • Example Response:
    								
    								{
    								  "enrichment_id": "xyz12345-6789-abcd-ef01-23456789ghij",
    								  "status": "completed",
    								  "data": { /* enriched contact details */ }
    								}
    								
    							
Authorization
  • Requires a Bearer authentication header: Bearer < token > (where < token > is your authentication key).
Path Parameters
  • enrichment_id (string) [Required]
    – The unique ID of the enrichment request.
Query Parameters
  • forceResults (boolean) [Optional]
    – Default = False.
    1. When True, the API returns partial results even if enrichment is incomplete.
    2. ⚠️ Not recommended for regular use as it may lead to missing data.
Response

200 OK – Successful Request

A successful request returns the following fields:

  • id (string)
    – Unique identifier for the enrichment request.
    Example: "a1b2c3d4-e5f6-7890-ghij-klmnopqrstuv"
  • name (string)
    – Custom label assigned to the request.
    Example:"Marketing Leads - Q4"
  • status (enum)
    – Current state of the enrichment process.
    Possible Values: CREATED, IN_PROGRESS, CANCELED, CREDITS_INSUFFICIENT, FINISHED, RATE_LIMIT, UNKNOWN
    Example: "FINISHED"
  • datas (object[])
    – Contains the enriched contact details.

Example Response:

							
							{
							  "id": "a1b2c3d4-e5f6-7890-ghij-klmnopqrstuv",
							  "name": "Marketing Leads - Q4",
							  "status": "FINISHED",
							  "datas": {
							    "custom": {
							      "crm_id": "98765"
							    },
							    "contact": {
							      /* Enriched contact attributes */
							    }
							  }
							}
						

 

 

 

										
										curl --request GET \
										  --url https://app.Deepenrich.com/api/v1/contact/enrich/bulk/{enrichment_id} \
										  --header 'Authorization: Bearer '
										
									
										
										import requests
										url = "https://app.Deepenrich.com/api/v1/contact/enrich/bulk/{enrichment_id}"
										headers = {"Authorization": "Bearer "}
										response = requests.request("GET", url, headers=headers)
										print(response.text)
										
									
										
										const options = {method: 'GET', headers: {Authorization: 'Bearer '}};
										fetch('https://app.Deepenrich.com/api/v1/contact/enrich/bulk/{enrichment_id}', 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/enrich/bulk/{enrichment_id}",
										  CURLOPT_RETURNTRANSFER => true,
										  CURLOPT_ENCODING => "",
										  CURLOPT_MAXREDIRS => 10,
										  CURLOPT_TIMEOUT => 30,
										  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
										  CURLOPT_CUSTOMREQUEST => "GET",
										  CURLOPT_HTTPHEADER => [
										    "Authorization: Bearer "
										  ],
										]);
										$response = curl_exec($curl);
										$err = curl_error($curl);
										curl_close($curl);
										if ($err) {
										  echo "cURL Error #:" . $err;
										} else {
										  echo $response;
										}
										
										
									
										
										
										package main
										import (
										"fmt"
										"net/http"
										"io/ioutil"
										)
										func main() {
										url := "https://app.Deepenrich.com/api/v1/contact/enrich/bulk/{enrichment_id}"
										req, _ := http.NewRequest("GET", url, nil)
										req.Header.Add("Authorization", "Bearer ")
										res, _ := http.DefaultClient.Do(req)
										defer res.Body.Close()
										body, _ := ioutil.ReadAll(res.Body)
										fmt.Println(res)
										fmt.Println(string(body))
										}
										
									
										
										HttpResponse response = Unirest.get("https://app.Deepenrich.com/api/v1/contact/enrich/bulk/{enrichment_id}")
										  .header("Authorization", "Bearer ")
										  .asString();
										
									
example
										
										{
										  "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
										  "name": "Sales Operations in London",
										  "status": "FINISHED",
										  "datas": [
										    {
										      "custom": {
										        "user_id": "12584"
										      },
										      "contact": {
										        "firstname": "john",
										        "lastname": "snow",
										        "domain": "example.com",
										        "most_probable_email": "[email protected]",
										        "most_probable_email_status": "HIGH_PROBABILITY",
										        "most_probable_phone": "+33 6 76 78 90 65",
										        "emails": [
										          {
										            "email": "[email protected]",
										            "status": "DELIVERABLE"
										          }
										        ],
										        "phones": [
										          {
										            "number": "+33 6 76 78 90 65",
										            "region": "FR"
										          }
										        ],
										        "social_medias": [
										          {
										            "url": "https://www.linkedin.com/in/john-snow",
										            "type": "LINKEDIN"
										          }
										        ],
										        "profile": {
										          "linkedin_id": 1234567890,
										          "linkedin_url": "https://www.linkedin.com/in/john-snow",
										          "linkedin_handle": "john-snow",
										          "sales_navigator_id": "ACoAAAAmaeEB8HhLAj6PTIYE1fU0DQc4CAkf8..",
										          "firstname": "john",
										          "lastname": "snow",
										          "premium_account": true,
										          "location": "Paris",
										          "summary": "Business oriented leader with broad experience within industry",
										          "headline": "CTO & cofounder",
										          "position": {
										            "title": "Chief Technical Officer",
										            "description": "...",
										            "start_at": {
										              "month": 6,
										              "year": 2024
										            },
										            "end_at": {
										              "month": 6,
										              "year": 2024
										            },
										            "company": {
										              "linkedin_id": 9876543210,
										              "linkedin_url": "https://www.linkedin.com/company/deepenrich",
										              "linkedin_handle": "deepenrich",
										              "name": "deepenrich",
										              "description": "...",
										              "website": "https://deepenrich.com",
										              "domain": "deepenrich.com",
										              "industry": "...",
										              "type": "...",
										              "year_founded": 1979,
										              "headcount": 27367,
										              "headcount_range": "10K+",
										              "headquarters": {
										                "region": "IDF",
										                "city": "Paris",
										                "country": "France",
										                "country_code": "FR",
										                "postal_code": "75001",
										                "address_line_1": "Avenue des champs elysées",
										                "address_line_2": ""
										              }
										            }
										          }
										        }
										      }
										    }
										  ]
										}
										
									
InProgress
										
										{
										  "code": "error.enrichment.in_progress",
										  "message": "Enrichement not ready, try again in 30 seconds"
										}
										
									
												
												{
												  "code": "error.authorization.not_set",
												  "message": "Authorization headers not set"
												}
												
											
												
												{
												  "code": "error.authorization.not_bearer",
												  "message": "Authorization headers not have prefix 'bearer'"
												}
												
											
												
												{
												  "code": "error.api.key",
												  "message": "Unknown api key"
												}
												
											
example
										
										{
										  "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
										  "name": "Sales Operations in London",
										  "status": "FINISHED",
										  "datas": [
										    {
										      "custom": {
										        "user_id": "12584"
										      },
										      "contact": {
										        "firstname": "john",
										        "lastname": "snow",
										        "domain": "example.com",
										        "most_probable_email": "[email protected]",
										        "most_probable_email_status": "HIGH_PROBABILITY",
										        "most_probable_phone": "+33 6 76 78 90 65",
										        "emails": [
										          {
										            "email": "[email protected]",
										            "status": "DELIVERABLE"
										          }
										        ],
										        "phones": [
										          {
										            "number": "+33 6 76 78 90 65",
										            "region": "FR"
										          }
										        ],
										        "social_medias": [
										          {
										            "url": "https://www.linkedin.com/in/john-snow",
										            "type": "LINKEDIN"
										          }
										        ],
										        "profile": {
										          "linkedin_id": 1234567890,
										          "linkedin_url": "https://www.linkedin.com/in/john-snow",
										          "linkedin_handle": "john-snow",
										          "sales_navigator_id": "ACoAAAAmaeEB8HhLAj6PTIYE1fU0DQc4CAkf8..",
										          "firstname": "john",
										          "lastname": "snow",
										          "premium_account": true,
										          "location": "Paris",
										          "summary": "Business oriented leader with broad experience within industry",
										          "headline": "CTO & cofounder",
										          "position": {
										            "title": "Chief Technical Officer",
										            "description": "...",
										            "start_at": {
										              "month": 6,
										              "year": 2024
										            },
										            "end_at": {
										              "month": 6,
										              "year": 2024
										            },
										            "company": {
										              "linkedin_id": 9876543210,
										              "linkedin_url": "https://www.linkedin.com/company/Deepenrich",
										              "linkedin_handle": "Deepenrich",
										              "name": "Deepenrich",
										              "description": "...",
										              "website": "https://deepenrich.com",
										              "domain": "Deepenrich.com",
										              "industry": "...",
										              "type": "...",
										              "year_founded": 1979,
										              "headcount": 27367,
										              "headcount_range": "10K+",
										              "headquarters": {
										                "region": "IDF",
										                "city": "Paris",
										                "country": "France",
										                "country_code": "FR",
										                "postal_code": "75001",
										                "address_line_1": "Avenue des champs elysées",
										                "address_line_2": ""
										              }
										            }
										          }
										        }
										      }
										    }
										  ]
										}
										
									
EnrichmentNotFound
										
										{
										  "code": "error.enrichment.not_found",
										  "message": "Enrichement ID not found"
										}