Skip to main content
Reveal a candidate's contact details (charges credits)

Authorizations

x-partner-key
string
header
required

Partner API key: vpk_live_ + 48 lowercase hex. Server-side only.

x-vort-org
string
header
required

Customer org token: vot_ + 48 lowercase hex, from /activations/redeem. Server-side only.

Headers

x-vort-lang
enum<string>

Language of notices and messages. Defaults to the partner default.

Available options:
he,
en

Path Parameters

run_id
string<uuid>
required
candidate_id
integer<int64>
required
Required range: x >= 1

Body

application/json
acting_user_external_id
string
required

Response

Revealed.

email
string | null
required
phone
string | null
required
credits_charged
integer
required
Required range: x >= 0
wallet_balance_after
integer
required