Anonymization API

Action	Endpoint
Anonymize Data	POST/compliance/{tenantLocator}/anonymize
Preview Anonymization	GET/compliance/{tenantLocator}/preview
Get Anonymization References	GET/compliance/{tenantLocator}/references

Anonymize Data

Anonymize DataanonymizeData

POST/compliance/{tenantLocator}/anonymize

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:AnonymizationRequest

Response:AnonymizationJobData[]

Security Group:compliance

Permission:

write

Preview Anonymization

Preview AnonymizationpreviewAnonymization

GET/compliance/{tenantLocator}/preview

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`request`	query	`AnonymizationRequest`	Yes

Response:AnonymizationPreviewResponse[]

Security Group:compliance

Permission:

read

Get Anonymization References

Get Anonymization ReferencesgetAnonymizationReferences

GET/compliance/{tenantLocator}/references

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`request`	query	`FetchAnonymizationReferencesRequest`	Yes

Response:AnonymizationReferenceResponse[]

Security Group:compliance

Permission:

read

AnonymizationRequest

Required properties

Property	Type	Description
`references`	`map<string, ulid[]>`

Optional properties

Property	Type	Description
`includeAcceptedQuotes`	`boolean?`
`policyStatuses`	`Enum[]? pending \| expired \| cancelled \| cancelPending \| onRisk \| delinquent \| doNotRenew`

AnonymizationJobData

Required properties

Property	Type	Description
`jobLocator`	`ulid`
`fromCurrentRequest`	`boolean`
`jobStatus`	`Enum initialized \| running \| suspended \| completed`
`referenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`assignedReferenceLocators`	`ulid[]`

AnonymizationPreviewResponse

Required properties

Property	Type	Description
`referenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`references`	`AnonymizationReferencePreviewResponse[]`

AnonymizationReferencePreviewResponse

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`state`	`Enum allowed \| restricted \| anonymized`

Optional properties

Property	Type	Description
`targets`	`TargetReferences[]?`

TargetReferences

Required properties

Property	Type	Description
`referenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`willAnonymize`	`boolean`

Optional properties

Property	Type	Description
`anonymizableReferenceLocators`	`ulid[]?`
`restrictedReferenceLocators`	`ulid[]?`

FetchAnonymizationReferencesRequest

Required properties

Property	Type	Description
`references`	`map<string, ulid[]>`

AnonymizationReferenceResponse

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`anonymizationState`	`Enum identifiable \| pending \| anonymized`
`parentReferenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`referenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`updatedAt`	`datetime`

Optional properties

Property	Type	Description
`anonymizationJobLocator`	`ulid?`
`parentReferenceLocator`	`ulid?`
`anonymizedAt`	`datetime?`
`scheduledAt`	`datetime?`
`postAnonymizationChildren`	`AnonymizationReferencesBatch[]?`
`preAnonymizationChildren`	`AnonymizationReferencesBatch[]?`

AnonymizationReferencesBatch

Required properties

Property	Type	Description
`referenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`referenceLocators`	`ulid[]`

Optional properties

Property	Type	Description
`parentJobLocator`	`ulid?`

Anonymization API

Anonymize Data

Preview Anonymization

Get Anonymization References

See Also

On this page