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

# Request a reveal

> Swaps a pseudonym for the handle, with a reason and a receipt.



## OpenAPI

````yaml openapi/en/cell.json POST /v1/insights/reveal
openapi: 3.1.0
info:
  title: Niadra data API
  version: '1'
  description: >-
    Writing, context, history, objects, identity, privacy and governance of one
    space. Every space has a stable address, with the space and the region in
    its name.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: The space, which comes in the source key.
      region:
        default: us-east-1
        description: The region of the space, which also comes in the key.
security: []
paths:
  /v1/insights/reveal:
    post:
      summary: Request a reveal
      description: >-
        Swaps a pseudonym for the handles of the customer. It needs a reason of
        at least 10 characters and elevated access: a source key with the
        `analytics` and `admin` scopes, or a person with the security role.
        Every reveal is recorded with its reason.


        **Authentication.** Source key with the `analytics` and `admin` scopes,
        or a Console person token with the security role (or admin).
      operationId: request_reveal_v1_insights_reveal_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevealRequest'
            example:
              pseudonym: psn_7f3a
              reason: Customer escalated to the ombudsman; case OMB-2026-311
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevealResponse'
              example:
                pseudonym: psn_7f3a
                kind: person
                handles:
                  - type: phone_e164
                    value: '+14155550123'
                    scope: null
          description: The handles behind the pseudonym.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: The request does not match the contract.
      security:
        - sourceKey: []
components:
  schemas:
    RevealRequest:
      additionalProperties: false
      properties:
        pseudonym:
          pattern: ^[A-Za-z0-9_-]{3,80}$
          title: Pseudonym
          type: string
        reason:
          maxLength: 1000
          minLength: 10
          title: Reason
          type: string
      required:
        - pseudonym
        - reason
      title: RevealRequest
      type: object
    RevealResponse:
      additionalProperties: false
      properties:
        handles:
          items:
            $ref: '#/components/schemas/RevealedHandle'
          title: Handles
          type: array
        kind:
          title: Kind
          type: string
        pseudonym:
          title: Pseudonym
          type: string
      required:
        - pseudonym
        - kind
        - handles
      title: RevealResponse
      type: object
    Problem:
      additionalProperties: false
      description: RFC 9457 problem details; `code` comes from the versioned error catalog.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    RevealedHandle:
      additionalProperties: false
      properties:
        scope:
          anyOf:
            - type: string
            - type: 'null'
          title: Scope
        type:
          title: Type
          type: string
        value:
          title: Value
          type: string
      required:
        - type
        - value
      title: RevealedHandle
      type: object
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...

````