> ## Documentation Index > Fetch the complete documentation index at: https://docs.vort-sourcing.com/llms.txt > Use this file to discover all available pages before exploring further. # Reveal a candidate's contact details (charges credits) > Show `reveal_price_credits` from the latest GET /runs/{run_id} before calling. A candidate already revealed for this organization is not charged again (`credits_charged: 0`). ## OpenAPI ````yaml /api-reference/openapi.yaml post /runs/{run_id}/candidates/{candidate_id}/reveal openapi: 3.1.0 info: title: Vort Partner API version: 1.0.0 summary: Server-to-server API for ATS vendors embedding Vort candidate matching. description: > Guides: [Integration flow](/integration-flow). UI rules: [UI specification](/ui-specification). Notices: [Notices](/notices). - Every call is server-to-server. `vpk_` keys and `vot_` org tokens MUST NOT reach a browser. - Clients MUST ignore unknown response fields; additive changes within v1 are non-breaking. - Notices with an unknown `code` MUST be rendered generically from `title` + `body`, styled by `severity`, placed by `slot`. - Rate limits are per partner (default 120/minute, 20,000/day); `429` carries `Retry-After`. - Sandbox ([Sandbox guide](/sandbox)): every sandbox response carries `x-vort-environment: sandbox`; names are masked, reveals are synthetic and free, `target_count` <= 20, 20 real runs per organization per 24 h, `cert-*` jobs run certification fixtures, and the sandbox-only headers `x-vort-sandbox-simulate` / `x-vort-sandbox-reveal-price` and route `POST /sandbox/webhooks/test` exist. None of these exist in production. contact: name: Vort partner support (always include the run_id) license: name: Proprietary identifier: LicenseRef-Vort-Proprietary servers: - url: https://vort-partner-api.vercel.app/sandbox/v1 description: Sandbox security: - partnerKey: [] orgToken: [] tags: - name: Activation description: Connect a customer organization by redeeming its one-time activation code. - name: Users description: Register the recruiters who act on runs (a field, never a credential). - name: Jobs description: Jobs the runs search for. - name: Runs description: Start runs and read their progress, notices and candidates. - name: Candidates description: Reveal candidate contact details (charges credits). - name: Decisions description: Report recruiter decisions and the notices shown (mandatory). - name: Sandbox description: >- Sandbox-only helpers (see the [Sandbox guide](/sandbox)). Not present in production (404). - name: Webhooks description: >- Events Vort posts to your registered HTTPS endpoint, signed with `x-vort-signature`. paths: /runs/{run_id}/candidates/{candidate_id}/reveal: post: tags: - Candidates summary: Reveal a candidate's contact details (charges credits) description: > Show `reveal_price_credits` from the latest GET /runs/{run_id} before calling. A candidate already revealed for this organization is not charged again (`credits_charged: 0`). operationId: revealCandidate parameters: - $ref: '#/components/parameters/RunId' - $ref: '#/components/parameters/CandidateId' - $ref: '#/components/parameters/Lang' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ActingUserRequest' example: acting_user_external_id: u-88121 responses: '200': description: Revealed. content: application/json: schema: $ref: '#/components/schemas/RevealResponse' example: email: yael.cohen@example.com phone: null credits_charged: 15 wallet_balance_after: 2435 '401': $ref: '#/components/responses/Unauthorized' '402': description: '`insufficient_credits`' content: application/json: schema: $ref: '#/components/schemas/InsufficientCreditsError' example: error: insufficient_credits message: Not enough credits to reveal this contact. balance: 10 required: 15 '403': $ref: '#/components/responses/Forbidden' '404': description: '`candidate_not_in_run`, `run_not_found` or `user_not_found`' content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: RunId: name: run_id in: path required: true schema: type: string format: uuid CandidateId: name: candidate_id in: path required: true schema: type: integer format: int64 minimum: 1 Lang: name: x-vort-lang in: header required: false description: Language of notices and messages. Defaults to the partner default. schema: type: string enum: - he - en schemas: ActingUserRequest: type: object required: - acting_user_external_id properties: acting_user_external_id: type: string RevealResponse: type: object required: - email - phone - credits_charged - wallet_balance_after properties: email: type: - string - 'null' phone: type: - string - 'null' credits_charged: type: integer minimum: 0 wallet_balance_after: type: integer InsufficientCreditsError: allOf: - $ref: '#/components/schemas/Error' - type: object required: - balance - required properties: error: const: insufficient_credits balance: type: integer required: type: integer Error: type: object description: >- Error envelope. Branch on `error`; unknown codes are handled by HTTP status. required: - error - message properties: error: type: string examples: - invalid_partner_key - invalid_org_token - partner_disabled - organization_disabled - rate_limited - rate_limit_unavailable - code_not_found - code_expired - external_id_taken - invalid_user - job_not_found - user_not_found - run_not_found - candidate_not_in_run - invalid_decision message: type: string additionalProperties: true responses: Unauthorized: description: '`invalid_partner_key` or `invalid_org_token`' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_org_token message: The organization token is not valid. Forbidden: description: '`partner_disabled` or `organization_disabled`' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: organization_disabled message: This organization's Vort connection is disabled. RateLimited: description: '`rate_limited`' headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: rate_limited message: Too many requests. ServiceUnavailable: description: >- `rate_limit_unavailable` — the rate limiter could not be checked, so the request was refused rather than let through unmetered. Retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: rate_limit_unavailable message: Rate limiting is temporarily unavailable. Retry shortly. headers: RetryAfter: description: Seconds to wait before retrying. schema: type: integer minimum: 0 securitySchemes: partnerKey: type: apiKey in: header name: x-partner-key description: 'Partner API key: `vpk_live_` + 48 lowercase hex. Server-side only.' orgToken: type: apiKey in: header name: x-vort-org description: >- Customer org token: `vot_` + 48 lowercase hex, from /activations/redeem. Server-side only. ````