Skip to main content
POST
Reveal contacts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional key used to safely retry a contact reveal request without spending credits twice.

Maximum string length: 255

Body

application/json
contact_ids
string[]
required
Required array length: 1 - 10 elements
Pattern: ^ct_[A-Za-z]+_[A-Za-z]{16}$

Response

Full contact data for contacts revealed with shared contact credits.

object
string
required
Allowed value: "contact_reveal_result"
credits
object
required
data
object[]
required
request_id
string
required