For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contact Enrichment API

Persona searches find contacts for you across a whole segment. Sometimes you already know exactly who you want — a webform signup, a name from an event list, an existing record in your CRM — and you just need the rest of their details.

The Contact Enrichment API takes a single person you already have a handle on and returns their verified identity, current employment, work email and, optionally, a mobile phone number. The contact is added to your dataset and can be synced straight back to your CRM, so the person stays up to date alongside everyone else GoodFit maintains for you.

Common uses:

  • Enriching a single contact in your CRM.

  • Looking up people from an event list.

  • Filling in webform signups with full details.

Note — This is an employment API: it returns a person at a company, not a standalone person record. Job title, start date and work email all describe that specific employment.

How it works

Enrichment is asynchronous, because finding and verifying someone's details takes longer than a single HTTP request should wait.

  1. POST /enrichment submits the request and returns a requestId immediately.

  2. Poll GET /enrichment/{requestId} every few seconds until the status is COMPLETE or ERROR.

  3. If you asked for a CRM sync, that follows once the enrichment completes.

Requests typically complete within one to two minutes.

Everything is optional except the person's identity. You can ask for a mobile number alongside the email, link the contact to a record in your CRM, and have the result written back to that CRM — or take the result and do nothing else with it.

In this section

What you get back

A resolved contact comes back with their name, LinkedIn profile, job title, employment start date and work email, plus the company they work at. A mobile number is included when you asked for one and we found it.

Returned emails carry the same verification statuses as every other email GoodFit supplies — see Email and Phone enrichment.

Contacts added this way behave like any other contact in your dataset: they're refreshed automatically, and if someone changes role or leaves, their details are updated.

Credit usage

Enrichment through this API draws on the same credits as a persona search:

  • One contact credit per contact added to your dataset. The work email is included — it isn't charged separately.

  • One phone credit if a mobile number is found. Nothing is charged when we can't find one.

  • One company enrichment credit if the company is new in your CRM.

Nothing is charged when we can't deliver a contact, so an ambiguous or not-found result costs you nothing. As with persona searches, you're only charged once for each unique person at a company — re-running the same request, or enriching someone a persona search already found, charges nothing. See Contact Credits.

We check your balance before starting work, so a request you can't pay for is rejected up front rather than half-completed.

Important — A contact credit is charged for every contact we deliver, including when the person turns out to have left the company. The result is returned with isFormerEmployment: true and is charged as normal.

Support

Contact your account manager, quoting the requestId for any request you have a question about.

Last updated