SIsignalshq
CLIENT

Unmask SSN (Unified)

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

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)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Request body

client_idstring uuid required

ID of the client whose entity's SSN to unmask

entity_idstring 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

reasonstring required

Reason for unmasking the SSN (for audit purposes)

Response

Successful Response

client_idstring uuid required

ID of the client

entity_idstring uuid nullable

ID of the entity (spouse or dependent)

entity_type'CLIENT' | 'SPOUSE' | 'DEPENDENT' required

Entity types for SSN information

entity_namestring required

Name of the entity

ssn_idstring uuid required

ID of the SSN record

unmasked_ssnstring required

Unmasked SSN (only returned to authorized users)

reasonstring required

Reason for unmasking the SSN

Changes

No recorded changes to this operation across all 1 revision of this API.