# Anonymization API



<EndpointIndex
  names={[
  	'anonymizeData',
  	'previewAnonymization',
  	'getAnonymizationReferences',
  ]}
/>

Anonymize Data [#anonymize-data]

<ApiEndpoint name="anonymizeData" />

Preview Anonymization [#preview-anonymization]

<ApiEndpoint name="previewAnonymization" />

Get Anonymization References [#get-anonymization-references]

<ApiEndpoint name="getAnonymizationReferences" />

<ApiSchema name="AnonymizationRequest" />

<ApiSchema name="AnonymizationJobData" />

<ApiSchema name="AnonymizationPreviewResponse" />

<ApiSchema name="AnonymizationReferencePreviewResponse" />

<ApiSchema name="TargetReferences" />

<ApiSchema name="FetchAnonymizationReferencesRequest" />

<ApiSchema name="AnonymizationReferenceResponse" />

<ApiSchema name="AnonymizationReferencesBatch" />

See Also [#see-also]

* [Data Anonymization](/features/security/data-anonymization)
* [Jobs API](/api/configuration-and-development/jobs)


## API Reference

POST /compliance/{tenantLocator}/anonymize — anonymizeData
Tags: compliance-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
Request body (AnonymizationRequest):
Responses:
  200 AnonymizationJobData[] — OK

GET /compliance/{tenantLocator}/preview — previewAnonymization
Tags: compliance-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  request (AnonymizationRequest, query, required)
Responses:
  200 AnonymizationPreviewResponse[] — OK

GET /compliance/{tenantLocator}/references — getAnonymizationReferences
Tags: compliance-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  request (FetchAnonymizationReferencesRequest, query, required)
Responses:
  200 AnonymizationReferenceResponse[] — OK

AnonymizationRequest
Properties:
  references (map<string, ulid[]>, required)
  includeAcceptedQuotes (boolean)
  policyStatuses (Enum[])

AnonymizationJobData
Properties:
  referenceType (Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement, required)
  jobLocator (ulid, required)
  jobStatus (Enum initialized | running | suspended | completed, required)
  assignedReferenceLocators (ulid[], required)
  fromCurrentRequest (boolean, required)

AnonymizationPreviewResponse
Properties:
  referenceType (Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement, required)
  references (AnonymizationReferencePreviewResponse[], required)

AnonymizationReferencePreviewResponse
Properties:
  referenceLocator (ulid, required)
  state (Enum allowed | restricted | anonymized, required)
  targets (TargetReferences[])

TargetReferences
Properties:
  referenceType (Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement, required)
  willAnonymize (boolean, required)
  anonymizableReferenceLocators (ulid[])
  restrictedReferenceLocators (ulid[])

FetchAnonymizationReferencesRequest
Properties:
  references (map<string, ulid[]>, required)

AnonymizationReferenceResponse
Properties:
  referenceType (Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement, required)
  referenceLocator (ulid, required)
  updatedAt (datetime, required)
  anonymizationState (Enum identifiable | pending | anonymized, required)
  parentReferenceType (Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement, required)
  parentReferenceLocator (ulid)
  anonymizationJobLocator (ulid)
  scheduledAt (datetime)
  anonymizedAt (datetime)
  preAnonymizationChildren (AnonymizationReferencesBatch[])
  postAnonymizationChildren (AnonymizationReferencesBatch[])

AnonymizationReferencesBatch
Properties:
  referenceType (Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement, required)
  referenceLocators (ulid[], required)
  parentJobLocator (ulid)