Enrich up to 50 person records at once

This endpoint allows you to enrich multiple person’s in one request while staying blazing-fast.

How are credits spent?

Credit spending using this endpoints depends on the enrichment parameters you submit and the matches that are returned.

The credit system works in the same way as the unique Enrich Person endpoint, and it can be controlled in the same way (using only_verified_email, enrich_mobile, only_verified_mobile).

Please refer to this section of the Enrich Person endpoint to understand how credits are spent.

Endpoint

• URL: https://api.prospeo.io/bulk-enrich-person 
• Method: POST
• Headers:
  • X-KEY: your_api_key
  • Content-Type: application/json

Parameters

The parameters are the same as the unique Enrich Person endpoint, except for the data parameter.

Data parameter

The data parameter for the /bulk-enrich-person endpoint is a list of all the persons you wish to enrich.

The data parameter contains the datapoints you have for us to identify the record. We offer the following matching datapoints:

Minimum requirements for matching

We require at a minimum the below datapoints together in one data object (allowing us to accurately identify the person):

• first_name + last_name + any of (company_name/company_website/company_linkedin_url)
• full_name + any of (company_name/company_website/company_linkedin_url)
• linkedin_url
• email
• person_id (enrich from /search-person)

Enrich records from our search API

Another way to enrich records is to use the person_id you get from the search results (/search-person) to this endpoint. This will identify the person and enrich as per your option (only_verified_email, only_verified_mobile, enrich_mobile).

Example request

Please refer to this section of the Enrich Person to understand how matching parameters works individually.

Whenever a parameter such as only_verified_email, it will apply to all of the object in the request.

We generated our own identifier (1,2,3,4,5,6,7) so that in case of a match, we can reconcile it with the response.

In the below request, the identifier 4 does not match the minimum matching requirements of a data object. Hence, this record will be ignored and provided in the invalid_datapoints list of the response.

We also enriched the identifier 7 by using its person_id we got from the /search-person endpoint.

POST "https://api.prospeo.io/bulk-enrich-person"
X-KEY: "your_api_key"
Content-Type: "application/json"
 
{
   "only_verified_email": true,
   "enrich_mobile": true,
   "data": [
   	{
   		"identifier": "1",
   		"full_name": "Eva Kiegler",
   		"company_website": "intercom.com"
   	},
   	{
   		"identifier": "2",
   		"first_name": "Jonah",
   		"last_name": "Stones",
   		"linkedin_url":  "https://www.linkedin.com/in/jonah-stones",
   		"company_name": "Deloitte",
   		"company_website": "deloitte.com",
   		"company_linkedin_url": "https://www.linkedin.com/company/deloitte"
   	},
   	{
   		"identifier": "3",
   		"linkedin_url":  "https://www.linkedin.com/in/micah-sanders"
   	},
   	{
   		"identifier": "4",
   		"full_name":  "Brandon Stering"
   	},
   	{
   		"identifier": "5",
   		"email":  "nicolas.b@kpmg.com"
   	},
   	{
   		"identifier": "6",
   		"full_name":  "Nicole Wonda",
   		"company_linkedin_url": "https://www.linkedin.com/company/young"
   	},
   	{
   		"identifier": "7",
   		"person_id":  "6f564548455488874f48e"
   	},
   	... up to 50 objects
   ]
}

Response

The response structure is as follow:

{
	"error": false,
	"total_cost": 10,
	"not_matched": ["2", "3"],
	"invalid_datapoints": ["4"],
	"matched": [
		{
			"identifier": "1",
			"person": {
				...
			},
			"company": {
				...
			}
		},
		{
			"identifier": "5",
			"person": {
				...
			},
			"company": {
				...
			}
		},
		{
			"identifier": "6",
			"person": {
				...
			},
			"company": {
				...
			}
		},
		{
			"identifier": "7",
			"person": {
				...
			},
			"company": {
				...
			}
		}
	]
}

Response details

Error codes

Rate limit

See our rate limits page.