List redaction entities

Lists all available redaction entities and their current activation status across different policies.

Redaction entities represent different types of sensitive information that can be automatically redacted from conversations. Each entity can be independently enabled or disabled for different redaction policies:

• Customer Immediate: Redaction in real-time for customer-facing content
• Customer Delayed: Redaction for stored customer-facing content
• Agent Immediate: Real-time redaction for agent-facing content
• Auto Transcribe: Redaction in transcription output
• Voice: Redaction in voice content

The API returns immediately, but the redaction service can take up to 1 minute to incorporate the redaction change.

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Query Parameters

cursor

string | null

The cursor pointing to the current position

limit

integer | null

default:20

The maximum amount of objects to retrieve

Required range: 1 <= x <= 100

Response

200

application/json

Successfully retrieved the redaction entities.

redactionEntities

object[]

required

The list of redaction entities

Show child attributes

redactionEntities.id

string

required

The id of the redaction entity

Example:

"CREDIT_CARD_NUMBER"

redactionEntities.description

string

required

The description of the redaction entity

Example:

""

redactionEntities.policies

object

required

A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored.

Show child attributes

redactionEntities.policies.customerImmediate

boolean

Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers.

Example:

true

redactionEntities.policies.customerDelayed

boolean

Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted.

Example:

false

redactionEntities.policies.agentImmediate

boolean

Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction.

Example:

false

redactionEntities.policies.autoTranscribe

boolean

Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation.

Example:

false

redactionEntities.policies.voice

boolean

Redact sensitive information during voice calls.

Example:

false

nextCursor

string | null

required

The next cursor to fetch

Example:

"6b29fc40-ca47-1067-b31d-00dd010662da"

prevCursor

string | null

required

The previous cursor to fetch

Example:

"04719ebd-13e1-40e9-8b92-0941cd16a19c"