Proprietary Transform Outputs

Proprietary Transform Outputs describe the response returned when Guardian Layer uses masking_type: "transform".

transform is Custodian Labs' proprietary de-identification algorithm. Other Guardian Layer modes, such as redact or masking, are privacy modes but are not proprietary transform outputs.

POST /api/v1/deidentify/text/proprietary/outputs

Use this page to understand the response shape for transform output and how to choose between returned candidates.

Response Shape

{
  "original_text": "Please contact Jane Smith at jane.smith@example.com.",
  "outputs": [
    {
      "id": 1,
      "text": "Please contact Maria Lopez at maria.lopez@example.com."
    },
    {
      "id": 2,
      "text": "Please contact David Kim at david.kim@example.com."
    }
  ],
  "mode": "PROPRIETARY_OUTPUTS",
  "meta": {
    "masking_type": "transform",
    "domain": "General",
    "level": 2
  }
}

Fields

Field	Type	Description
`original_text`	string	The input text sent in the request.
`outputs`	array	Proprietary transform output candidates.
`outputs[].id`	integer	Output candidate identifier.
`outputs[].text`	string	De-identified text produced by transform mode.
`mode`	string	Response mode. For this endpoint, the value is `PROPRIETARY_OUTPUTS`.
`meta`	object	Additional processing metadata.

Output Candidates

The endpoint returns transform candidates in the outputs array.

For most application flows, use the first output by default:

{
  "id": 1,
  "text": "Please contact Maria Lopez at maria.lopez@example.com."
}

If your product has a review workflow, you can show multiple transform candidates and let a reviewer choose the best one.

Transform Mode

When masking_type is transform, detected sensitive values are replaced with safer readable alternatives.

{
  "masking_type": "transform"
}

Use transform when readability matters and you want the proprietary de-identification algorithm.

Relationship to Other Guardian Layer Modes

This page focuses on outputs from transform, Custodian Labs' proprietary de-identification algorithm.

Other Guardian Layer modes, such as redact, masking, and placeholder-style replacements, are privacy transformation modes rather than proprietary transform outputs. For those behaviors, see Redact / Masking / Placeholder.

Metadata

The meta object may include values such as:

Field	Description
`masking_type`	The output style used for the request. For proprietary transform outputs, this is `transform`.
`domain`	The requested domain.
`level`	The requested level of transform.
`pii_entities`	Entity categories used for filtering, if provided.
`plan_name`	Plan associated with the API key, when available.

Additional metadata may be added over time.

Response Shape​

Fields​

Output Candidates​

Transform Mode​

Relationship to Other Guardian Layer Modes​

Metadata​

Related Pages​