Skip to main content
id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
redaction
customer
string
required

The ID of the customer this redaction applies to.

error
string | null
required

A human-readable error message when status is failed.

redacted_at
integer | null
required

Time at which the redaction completed. Measured in seconds since the Unix epoch.

redacted_objects
object[]
required

Objects whose personally identifiable information was wiped, such as customer, invoice, application, tenancy, payment_method, verification_session, and verification_report.

status
enum<string>
required

The status of the redaction. processing while PII is being wiped, redacted when complete, and failed when the job could not finish.

Available options:
processing,
redacted,
failed
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.