---
title: "Unmask SSN (Unified)"
method: POST
path: "/internal/api/clients/ssn/unmask"
tags: ["CLIENT"]
---

# Unmask SSN (Unified)

`POST /internal/api/clients/ssn/unmask`

## Request

- Base URL: `https://api.signalshq.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.signalshq.io/internal/api/clients/ssn/unmask`
- Auth: OAuth 2
  - Password
  - Token URL: `/auth/login`

Decrypt and return the unmasked SSN for any entity type (CLIENT, SPOUSE, or DEPENDENT). Single endpoint for all SSN unmask operations.

## Request body

- SSNUnmaskRequest: Request schema for unmasking SSN
  - `client_id` string, uuid, required: ID of the client whose entity's SSN to unmask
  - `entity_id` string, uuid, nullable: ID of the entity (spouse or dependent) whose SSN to unmask. Null for client SSN.
  - `entity_type` 'CLIENT' | 'SPOUSE' | 'DEPENDENT', required: Entity types for SSN information
  - `reason` string, required: Reason for unmasking the SSN (for audit purposes)

## Response `200`

Successful Response

- SSNUnmaskResponse: Response schema for unmasked SSN
  - `client_id` string, uuid, required: ID of the client
  - `entity_id` string, uuid, nullable: ID of the entity (spouse or dependent)
  - `entity_type` 'CLIENT' | 'SPOUSE' | 'DEPENDENT', required: Entity types for SSN information
  - `entity_name` string, required: Name of the entity
  - `ssn_id` string, uuid, required: ID of the SSN record
  - `unmasked_ssn` string, required: Unmasked SSN (only returned to authorized users)
  - `reason` string, required: Reason for unmasking the SSN

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/signalshq/apis/signals-api.md) - [All operations](https://skmtc.dev/signalshq/apis/signals-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signalshq/apis/signals-api/revisions/2c22af3b5576?raw)