Skip to content
Docs

Reveal people contact details

Early access. Tell us what you're building and we'll set you up. Contact us

POSTapi.lempile.com/people/reveal

Reveals raw contact details for an approved people record. This route requires people.reveal, reveal-approved source provenance, workspace credits, rate-limit clearance, and writes an audit event. Repeated reveals of the same contact by the same workspace are not charged again.

Authentication

X-API-KEY header·A Lempile API key, made in the dashboard under Access tokens.

Request body

  • Option 1any
  • Option 2any

Responses

200

People contact reveal result.

›

application/json

  • objectanyrequired
    Alwayspeople_contact
  • record_idstring | nullrequired
  • source_record_idstringrequired
  • chargedbooleanrequired
  • remaining_creditsinteger | nullrequired
  • contactobjectrequired
    ›Show fields
    • emailstring | nullrequired
    • email_statusstring | nullrequired
    • email_confidencenumber | nullrequired
    • phonestring | nullrequired
    • phone_statusstring | nullrequired
400

Invalid reveal request.

›

application/json

  • errorstringrequired
  • messagestringrequired
401

Missing or invalid API key.

›

application/json

  • errorstringrequired
  • messagestringrequired
402

Workspace has no People reveal credits available.

›

application/json

  • errorstringrequired
  • messagestringrequired
403

API key lacks people.reveal, or the source is not approved for reveal.

›

application/json

  • errorstringrequired
  • messagestringrequired
404

Contact record or requested contact field is not available.

›

application/json

  • errorstringrequired
  • messagestringrequired
429

People reveal rate limit exceeded.

›

application/json

  • errorstringrequired
  • messagestringrequired

Was this page helpful?