> ## Documentation Index
> Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reveal a secret field

> Returns the decrypted value of a secret/encrypted contact field.

Requires the **`contacts`** permission on the service account that owns your API key. A key whose service account lacks it fails with `"Lacking necessary permission contacts"`.

**A missing record does not return 404.** This handler reports the failure without a status code, and the error envelope defaults to HTTP `200` — you get `200` with `status: "failed"`. Branch on `status`, not on the HTTP code.



## OpenAPI

````yaml /api-reference/specs/contacts.json get /api/contacts/{id}/reveal-secret
openapi: 3.1.0
info:
  title: ConveYour API — Contacts
  description: >-
    Contacts are the core data object in ConveYour. Every person in your system
    — a learner, rep, or prospect — is a contact.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Contacts
    description: >-
      Contacts are the core data object in ConveYour. Every person in your
      system — a learner, rep, or prospect — is a contact.
paths:
  /api/contacts/{id}/reveal-secret:
    get:
      tags:
        - Contacts
      summary: Reveal a secret field
      description: >-
        Returns the decrypted value of a secret/encrypted contact field.


        Requires the **`contacts`** permission on the service account that owns
        your API key. A key whose service account lacks it fails with `"Lacking
        necessary permission contacts"`.


        **A missing record does not return 404.** This handler reports the
        failure without a status code, and the error envelope defaults to HTTP
        `200` — you get `200` with `status: "failed"`. Branch on `status`, not
        on the HTTP code.
      operationId: revealContactSecret
      parameters:
        - $ref: '#/components/parameters/contactId'
        - name: field_name
          in: query
          required: true
          description: The name of the encrypted field to reveal.
          schema:
            type: string
          example: ssn
        - name: public_key
          in: query
          description: >-
            Required only when your org has `require_public_encryption_key`
            enabled. Base64-encoded public key used for re-encryption.
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: The decrypted field value.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/RevealedSecret'
              example:
                status: ok
                message: success
                data:
                  field_value: 123-45-6789
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    contactId:
      name: id
      in: path
      required: true
      description: The contact's internal ID.
      schema:
        type: string
      example: 64a1b2c3d4e5f6a7b8c9d0e1
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    RevealedSecret:
      type: object
      description: >-
        The decrypted value of one encrypted field. Returns an empty string when
        the field holds no value.
      properties:
        field_value:
          type: string
          description: The decrypted value, or an empty string.
      required:
        - field_value
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.