import ContextDev from 'context.dev';
const client = new ContextDev({
apiKey: process.env['CONTEXT_DEV_API_KEY'], // This is the default and can be omitted
});
const response = await client.people.enrich({
company: { name: 'Analytical Engines', domain: 'analyticalengines.example' },
name: { first: 'Ada', last: 'Lovelace' },
social_urls: ['https://www.linkedin.com/in/ada-lovelace/'],
});
console.log(response.match);import os
from context.dev import ContextDev
client = ContextDev(
api_key=os.environ.get("CONTEXT_DEV_API_KEY"), # This is the default and can be omitted
)
response = client.people.enrich(
company={
"name": "Analytical Engines",
"domain": "analyticalengines.example",
},
name={
"first": "Ada",
"last": "Lovelace",
},
social_urls=["https://www.linkedin.com/in/ada-lovelace/"],
)
print(response.match)package main
import (
"context"
"fmt"
"github.com/context-dot-dev/context-go-sdk"
"github.com/context-dot-dev/context-go-sdk/option"
)
func main() {
client := contextdev.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.People.Enrich(context.TODO(), contextdev.PersonEnrichParams{
Company: contextdev.PersonEnrichParamsCompany{
Name: contextdev.String("Analytical Engines"),
Domain: contextdev.String("analyticalengines.example"),
},
Name: contextdev.PersonEnrichParamsName{
First: contextdev.String("Ada"),
Last: contextdev.String("Lovelace"),
},
SocialURLs: []string{"https://www.linkedin.com/in/ada-lovelace/"},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Match)
}
require "context_dev"
context_dev = ContextDev::Client.new(api_key: "My API Key")
response = context_dev.people.enrich
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use ContextDev\Client;
use ContextDev\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('CONTEXT_DEV_API_KEY') ?: 'My API Key');
try {
$response = $client->people->enrich(
company: [
'domain' => 'analyticalengines.example', 'name' => 'Analytical Engines'
],
education: [
[
'degree' => 'x',
'fieldOfStudy' => 'x',
'graduationYear' => 1900,
'institution' => ['domain' => 'x', 'name' => 'x'],
],
],
email: '[email protected]',
location: ['city' => 'x', 'country' => 'x', 'region' => 'x'],
name: ['first' => 'Ada', 'last' => 'Lovelace'],
socialURLs: ['https://www.linkedin.com/in/ada-lovelace/'],
tags: ['production', 'team-alpha'],
timeoutMs: 1000,
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}context-dev people enrich \
--api-key 'My API Key'curl --request POST \
--url https://api.context.dev/v1/people/enrich \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"social_urls": [
"https://www.linkedin.com/in/ada-lovelace/"
],
"name": {
"first": "Ada",
"last": "Lovelace"
},
"company": {
"name": "Analytical Engines",
"domain": "analyticalengines.example"
}
}
'HttpResponse<String> response = Unirest.post("https://api.context.dev/v1/people/enrich")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"social_urls\": [\n \"https://www.linkedin.com/in/ada-lovelace/\"\n ],\n \"name\": {\n \"first\": \"Ada\",\n \"last\": \"Lovelace\"\n },\n \"company\": {\n \"name\": \"Analytical Engines\",\n \"domain\": \"analyticalengines.example\"\n }\n}")
.asString();{
"match": {
"status": "candidate",
"score": 50,
"person": {
"social_urls": [
"<string>"
],
"website_urls": [
"<string>"
],
"experience": [
{
"title": "<string>",
"organization": {
"name": "<string>",
"domain": "<string>"
},
"location": "<string>",
"description": "<string>",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
},
"is_current": true
}
],
"education": [
{
"institution": {
"name": "<string>",
"domain": "<string>"
},
"degree": "<string>",
"field_of_study": "<string>",
"description": "<string>",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
}
}
],
"skills": [
"<string>"
],
"name": {
"full": "<string>",
"first": "<string>",
"last": "<string>"
},
"email": "[email protected]",
"avatar_url": "<string>",
"bio": "<string>",
"location": {
"display": "<string>",
"city": "<string>",
"region": "<string>",
"country": "<string>",
"country_code": "<string>"
},
"current_role": {
"title": "<string>",
"organization": {
"name": "<string>",
"domain": "<string>"
},
"location": "<string>",
"description": "<string>",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
},
"is_current": true
}
}
},
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"status": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"error_code": "RATE_LIMITED",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}Enrich Person
Enrich a person from combined identity clues and receive an identity match score.
import ContextDev from 'context.dev';
const client = new ContextDev({
apiKey: process.env['CONTEXT_DEV_API_KEY'], // This is the default and can be omitted
});
const response = await client.people.enrich({
company: { name: 'Analytical Engines', domain: 'analyticalengines.example' },
name: { first: 'Ada', last: 'Lovelace' },
social_urls: ['https://www.linkedin.com/in/ada-lovelace/'],
});
console.log(response.match);import os
from context.dev import ContextDev
client = ContextDev(
api_key=os.environ.get("CONTEXT_DEV_API_KEY"), # This is the default and can be omitted
)
response = client.people.enrich(
company={
"name": "Analytical Engines",
"domain": "analyticalengines.example",
},
name={
"first": "Ada",
"last": "Lovelace",
},
social_urls=["https://www.linkedin.com/in/ada-lovelace/"],
)
print(response.match)package main
import (
"context"
"fmt"
"github.com/context-dot-dev/context-go-sdk"
"github.com/context-dot-dev/context-go-sdk/option"
)
func main() {
client := contextdev.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.People.Enrich(context.TODO(), contextdev.PersonEnrichParams{
Company: contextdev.PersonEnrichParamsCompany{
Name: contextdev.String("Analytical Engines"),
Domain: contextdev.String("analyticalengines.example"),
},
Name: contextdev.PersonEnrichParamsName{
First: contextdev.String("Ada"),
Last: contextdev.String("Lovelace"),
},
SocialURLs: []string{"https://www.linkedin.com/in/ada-lovelace/"},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Match)
}
require "context_dev"
context_dev = ContextDev::Client.new(api_key: "My API Key")
response = context_dev.people.enrich
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use ContextDev\Client;
use ContextDev\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('CONTEXT_DEV_API_KEY') ?: 'My API Key');
try {
$response = $client->people->enrich(
company: [
'domain' => 'analyticalengines.example', 'name' => 'Analytical Engines'
],
education: [
[
'degree' => 'x',
'fieldOfStudy' => 'x',
'graduationYear' => 1900,
'institution' => ['domain' => 'x', 'name' => 'x'],
],
],
email: '[email protected]',
location: ['city' => 'x', 'country' => 'x', 'region' => 'x'],
name: ['first' => 'Ada', 'last' => 'Lovelace'],
socialURLs: ['https://www.linkedin.com/in/ada-lovelace/'],
tags: ['production', 'team-alpha'],
timeoutMs: 1000,
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}context-dev people enrich \
--api-key 'My API Key'curl --request POST \
--url https://api.context.dev/v1/people/enrich \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"social_urls": [
"https://www.linkedin.com/in/ada-lovelace/"
],
"name": {
"first": "Ada",
"last": "Lovelace"
},
"company": {
"name": "Analytical Engines",
"domain": "analyticalengines.example"
}
}
'HttpResponse<String> response = Unirest.post("https://api.context.dev/v1/people/enrich")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"social_urls\": [\n \"https://www.linkedin.com/in/ada-lovelace/\"\n ],\n \"name\": {\n \"first\": \"Ada\",\n \"last\": \"Lovelace\"\n },\n \"company\": {\n \"name\": \"Analytical Engines\",\n \"domain\": \"analyticalengines.example\"\n }\n}")
.asString();{
"match": {
"status": "candidate",
"score": 50,
"person": {
"social_urls": [
"<string>"
],
"website_urls": [
"<string>"
],
"experience": [
{
"title": "<string>",
"organization": {
"name": "<string>",
"domain": "<string>"
},
"location": "<string>",
"description": "<string>",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
},
"is_current": true
}
],
"education": [
{
"institution": {
"name": "<string>",
"domain": "<string>"
},
"degree": "<string>",
"field_of_study": "<string>",
"description": "<string>",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
}
}
],
"skills": [
"<string>"
],
"name": {
"full": "<string>",
"first": "<string>",
"last": "<string>"
},
"email": "[email protected]",
"avatar_url": "<string>",
"bio": "<string>",
"location": {
"display": "<string>",
"city": "<string>",
"region": "<string>",
"country": "<string>",
"country_code": "<string>"
},
"current_role": {
"title": "<string>",
"organization": {
"name": "<string>",
"domain": "<string>"
},
"location": "<string>",
"description": "<string>",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
},
"is_current": true
}
}
},
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"status": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"error_code": "RATE_LIMITED",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}Authorizations
Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.
Body
Identity clues for one person. Provide a person email, a person-profile social URL, or both first and last name with company, education, or location. All supplied clues are considered together.
1 - 20 elementsShow child attributes
Show child attributes
320Show child attributes
Show child attributes
1 - 10 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).
1000 <= x <= 300000Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
201 - 50["production", "team-alpha"]
Response
The highest-scoring candidate, including weak matches, or a not-found result when no usable candidate exists.
The highest-scoring person candidate.
- Candidate match
- No match
Show child attributes
Show child attributes
Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.
Show child attributes
Show child attributes
Was this page helpful?