Anonymization API
Endpoint Index
Action | Endpoint |
---|---|
Anonymize Data | POST /compliance/{tenantLocator}/anonymize |
Preview Anonymization | GET /compliance/{tenantLocator}/preview |
Get Anonymization References | GET /compliance/{tenantLocator}/references |
POST /compliance/{tenantLocator}/anonymize
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:AnonymizationRequest
Response:AnonymizationJobData[]
Security Group:compliance  Permission:write
GET /compliance/{tenantLocator}/preview
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
request | query | AnonymizationRequest | required |
Response:AnonymizationPreviewResponse[]
Security Group:compliance  Permission:read
GET /compliance/{tenantLocator}/references
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
request | query | FetchAnonymizationReferencesRequest | required |
Response:AnonymizationReferenceResponse[]
Security Group:compliance  Permission:read
AnonymizationRequest
¶requiredreferences AnonymizationReference[]optionalincludeAcceptedQuotes boolean?policyStatuses Enum[]? cancelled | cancelPending | delinquent | doNotRenew | expired | inGap | onRisk | pending
AnonymizationReference
¶requiredreferenceLocator stringreferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursement
AnonymizationJobData
¶requiredjobLocator stringfromCurrentRequest booleanjobStatus Enum initialized | running | suspended | completedreferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursementassignedReferenceLocators string[]
AnonymizationPreviewResponse
¶requiredreferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursementreferences AnonymizationReferencePreviewResponse[]
AnonymizationReferencePreviewResponse
¶requiredreferenceLocator stringstate Enum allowed | restricted | anonymizedoptionaltargets TargetReferences[]?
TargetReferences
¶requiredreferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursementwillAnonymize booleanoptionalanonymizableReferenceLocators string[]?restrictedReferenceLocators string[]?
FetchAnonymizationReferencesRequest
¶requiredreferences AnonymizationReference[]
AnonymizationReferenceResponse
¶requiredreferenceLocator stringanonymizationState Enum identifiable | pending | anonymizedparentReferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursementreferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursementupdatedAt datetimeoptionalanonymizationJobLocator string?parentReferenceLocator string?anonymizedAt datetime?scheduledAt datetime?postAnonymizationChildren AnonymizationReferencesBatch[]?preAnonymizationChildren AnonymizationReferencesBatch[]?
AnonymizationReferencesBatch
¶requiredreferenceType Enum none | account | quickQuote | quote | policy | contact | fnol | payment | disbursementreferenceLocators string[]optionalparentJobLocator string?