RecruitAffiliates.ai

Reveal a prospect's email

Looks up the email address of one saved prospect. Spends one email credit, only when a usable address comes back: if nothing is found the credit is refunded in the same call, and refunded says so. A prospect already revealed costs nothing.

Send an Idempotency-Key: a retry with the same key answers the first result and never spends twice.

A test key answers a sample address and spends nothing.

Scope: finder:write

post/v1/finder/prospects/{id}/reveal_email

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/finder/prospects/{id}/reveal_email
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (fdi_…)

Example:fdi_7uSyy9FqVLCFWrdPeZaK

Response

What the look found

object'finder_email_reveal' required
prospect_idstring required

Prefixed id (fdi_…)

foundboolean required

True when a usable address came back, or the prospect already had one

emailstring nullable required
verification'verified' | 'unverified' | 'null' nullable required

unverified covers catch-all domains too

sourcestring nullable required

Where the address was found, like website or hunter

chargedboolean required

True when this call spent one email credit

refundedboolean required

True when the credit was spent and then given back because nothing usable came back

already_revealedboolean required
reason_codestring nullable required

Why nothing was found: no_result, invalid, provider_failure, timeout or budget

reasonstring nullable required

The same, as a sentence you can show a person

livemodeboolean required
deliverability'verified' | 'catch_all' | 'mx_ok' | 'unchecked' | 'invalid' | 'null' nullable required

What we know about whether the address takes mail: verified (the mail server accepted it), catch_all (the server accepts every address, so it may still bounce), mx_ok (not checked itself, but its domain has a mail server), unchecked (nothing checked, or the check timed out) or invalid. Null when nothing was found.

Example response

{
  "prospect_id": "fdi_7uSyy9FqVLCFWrdPeZaK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.