docs
Enrichment

Look up one person

POST
/v1/enrich

Looks up one person by email, phone, IP address, MD5 hash or postal address. Costs 1 chip only when we find a match. No match is free, but you need at least 1 chip to look someone up.

This call can spend chips. Send an Idempotency-Key header so a retry never charges twice.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Create a key in the app under Developers. Keys start with dcd_live_.

Header Parameters

Idempotency-Key?string

Unique string for this request. Repeat the call with the same key within 24 hours and you get the original result, marked with the header Idempotent-Replayed: true, without being charged or building twice. Reusing a key with a different request is a 409. A request that failed can be retried with the same key.

Length1 <= length <= 255

Request Body

application/json
  1. body

Look up one person. Free unless we find a match, which costs 1 chip.

email?string

Email address to look up.

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
phone?string

Phone number to look up.

Length1 <= length
ip?string

IPv4 or IPv6 address to look up.

Length1 <= length
md5?string

MD5 hash of an email address, 32 hex characters.

Match^[a-fA-F0-9]{32}$
address?

Postal address to look up.

max_chips?integer

The most chips you are willing to spend. A match costs 1 chip, so any value of 1 or more works. No match is free.

Range1 <= value <= 9007199254740991

Response Body

Success.

application/json
  1. response
matched*boolean

Whether we found a match.

lead*|

The matched lead, in full. Null when there was no match.

chips_charged*integer

Chips spent by this call. 0 when there was no match or you already had the lead.

Range0 <= value <= 9007199254740991
balance*integer

Chips left after this call.

Range0 <= value <= 9007199254740991
request_id*string

Id of the request that produced this response. A replayed idempotent response keeps the original id.

curl -X POST 'https://api.diced.si/v1/enrich' \  -H 'Authorization: Bearer dcd_live_your_key' \  -H 'Idempotency-Key: 9b2f6c1e-4d7a-4f0b-8e3a-1c5d2e7f9a04' \  -H 'Content-Type: application/json' \  -d '{  "email": "jane@example.com",  "max_chips": 1}'
Example Response
{  "matched": true,  "lead": {    "id": "string",    "first_name": "string",    "last_name": "string",    "email": "string",    "emails": [      "string"    ],    "business_email": "string",    "phone": "string",    "mobile_phone": "string",    "direct_phone": "string",    "linkedin_url": "string",    "address": {      "line1": "string",      "line2": "string",      "city": "string",      "state": "string",      "zip": "string",      "country": "string"    },    "demographics": {      "gender": "male",      "age_range": "18-24",      "married": true,      "children": true,      "income_range": "<20k",      "net_worth": "<0",      "homeowner": true    },    "job": {      "title": "string",      "seniority": "c_suite",      "department": "administrative"    },    "company": {      "name": "string",      "domain": "string",      "phone": "string",      "industry": "string",      "size": "1-10",      "revenue": "<1m",      "sic": "string",      "naics": "string",      "city": "string",      "state": "string",      "country": "string"    },    "intent": {      "level": "high",      "topic": {        "id": "string",        "name": "string",        "category": "string"      },      "last_active": "string"    },    "household": {      "property1": "string",      "property2": "string"    },    "updated_at": "string"  },  "chips_charged": 0,  "balance": 0,  "request_id": "string"}