curl -X POST "<base_url>/dpp/dbos/v2/id-enrichment-by-name-location" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"firstName": "string",
"lastName": "string",
"city": "string",
"state": "string",
"zip": "string",
"countryCode": "US"
}'
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"found": true,
"firstName": [
"string"
],
"lastName": [
"string"
],
"alsoKnownAs": [
"string"
],
"age": [
"string"
],
"address": [
"string"
],
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"phone": [
"string"
],
"relatives": [
"string"
],
"associates": [
"string"
],
"country": "UNITED STATES",
"countryCode": "US"
}
}
ID Enrichment
Person Lookup
Resolves a person from name + location into one merged identity profile: aliases, ages, addresses, phone numbers and relatives.
POST
/
dpp
/
dbos
/
v2
/
id-enrichment-by-name-location
curl -X POST "<base_url>/dpp/dbos/v2/id-enrichment-by-name-location" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"firstName": "string",
"lastName": "string",
"city": "string",
"state": "string",
"zip": "string",
"countryCode": "US"
}'
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"found": true,
"firstName": [
"string"
],
"lastName": [
"string"
],
"alsoKnownAs": [
"string"
],
"age": [
"string"
],
"address": [
"string"
],
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"phone": [
"string"
],
"relatives": [
"string"
],
"associates": [
"string"
],
"country": "UNITED STATES",
"countryCode": "US"
}
}
Resolves a person from name + location into one merged identity profile: aliases, ages, addresses, phone numbers and relatives. Required: firstName, lastName, and at least one of city / state. found: true means a record matched; found: false means the query ran but nothing matched (arrays empty, message set), still a success. To look a person up by phone, use POST /dpp/dbos/v2/id-enrichment-by-phone.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dbos/v2/id-enrichment-by-name-location - Full URL:
<base_url>/dpp/dbos/v2/id-enrichment-by-name-location - Request Method: POST
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Request Body
firstName and lastName are always required, plus at least one of city / state.string
required
Letters, spaces, hyphens, apostrophes and periods only.
string
required
Letters, spaces, hyphens, apostrophes and periods only.
string
Required unless state is supplied.
string
Required unless city is supplied. Two-letter code or full name.
string
Optional; narrows the match.
string
Optional ISO 3166-1 alpha-2 code.
Sample Request
cURL
curl -X POST "<base_url>/dpp/dbos/v2/id-enrichment-by-name-location" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"firstName": "string",
"lastName": "string",
"city": "string",
"state": "string",
"zip": "string",
"countryCode": "US"
}'
curl -X POST "<base_url>/dpp/dbos/v2/id-enrichment-by-name-location" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"firstName": "string",
"lastName": "string",
"city": "string",
"state": "string",
"zip": "string",
"countryCode": "US"
}'
Response
object
object
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"found": true,
"firstName": [
"string"
],
"lastName": [
"string"
],
"alsoKnownAs": [
"string"
],
"age": [
"string"
],
"address": [
"string"
],
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"phone": [
"string"
],
"relatives": [
"string"
],
"associates": [
"string"
],
"country": "UNITED STATES",
"countryCode": "US"
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"found": true,
"firstName": [
"string"
],
"lastName": [
"string"
],
"alsoKnownAs": [
"string"
],
"age": [
"string"
],
"address": [
"string"
],
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"phone": [
"string"
],
"relatives": [
"string"
],
"associates": [
"string"
],
"country": "UNITED STATES",
"countryCode": "US"
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | Success. Inspect body.found to tell a match from a no-match. |
400 | 10002: a required field is missing, a field has a character that is not allowed. |
502 | Lookup service unavailable. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
10001 | Internal server error / Unsupported Media Type |
10002 | A required field is missing, a field has a character that is not allowed. |