Skip to main content
Read candidates while a campaign runs, and results once they finish. Both carry your external_id and the candidate’s full phone number, so you can match them to your own records.
Answers are self-reported and not verified. No verification link is ever returned.

How to get results

Read them with GET /results. A result is written once, when a candidate finishes or declines, and never changes, so it is final the moment it appears. Poll as often as suits you (reads have their own rate limit), page with cursor until has_more is false, and skip a result_id you already stored. Many integrations poll every minute or two, and again after starting a campaign.

Candidate or result?

Endpoints

List candidates

GET /enrichments/{enrichment_id}/candidates Every candidate of an enrichment and where each stands, most recently finished first. Scope: enrichment:read
Response · 200
answers is the answer text per question_id. completed_channel is where they finished: whatsapp, sms, voice or web.

Get a candidate

GET /enrichments/{enrichment_id}/candidates/{candidate_id} One candidate in full. Scope: enrichment:read · Errors: 404 NOT_FOUND
  • journey shows what was sent and when: the invite, follow-ups, SMS, call attempts, link opened and opt-out.
  • answers has every question, answered or not, with text, the channel it came on, an English transcript for a spoken answer (transcript_english) and, for yes_no, whether it qualified.
  • result is the final result once the candidate has finished, otherwise null.
The English transcript of a spoken answer is translated the first time it is read, so that first read can be slower.

List results

GET /enrichments/{enrichment_id}/results The final result of each candidate who finished or declined, newest first. Scope: enrichment:read
Response · 200
Poll this endpoint for new results: they are final as soon as they appear.