Redaction Job Validation Errors Preview

The Redaction Job validation error object contains information about errors that affect the ability to redact a specific object in a redaction job.

Was this section helpful? Yes No

List all validation errors

GET / v1 / privacy / redaction_jobs /:id / validation_errors

The Redaction Job Validation Error object Preview

Attributes

id string Unique identifier for the object.
object string, value is "privacy.redaction_job_validation_error" String representing the object’s type. Objects of the same type share the same value.
code enum A code indicating the reason for the error. Possible enum values invalid_cascading_source The object is not redactable because of a related object’s existing state. Refer to the message prop for more context. invalid_file_purpose The object’s related file is not redactable. Refer to the message prop for more context. invalid_state The object is not redactable because of its own existing state. Refer to the message prop for more context. locked_by_other_job The object is currently used in another redaction job. Cancel the other job to resolve this error. too_many_objects Your job is trying to redact too many objects. Cancel this job and reduce the number of IDs in the Redaction Job’s objects prop in a new job. If this error persists, reach out to support.
erroring _ object nullable object If the error is related to a specific object, this field includes the object’s identifier and object type.
message string A human-readable message providing more details about the error.

The Redaction Job Validation Error object

{ "id": "prjve_123", "object": "privacy.redaction_job_validation_error", "code": "invalid_state", "erroring_object": { "id": "pi_123", "object_type": "payment_intent" }, "message": "PaymentIntent is not finalized. Confirm or cancel the payment intent."}

List all validation errors

GET / v1 / privacy / redaction_jobs /:id / validation_errors

Returns a list of validation errors for the specified redaction job.

Parameters

job string Required RedactionJob object identifier

More parameters

ending _ before string
limit integer
starting _ after string

Returns

Returns a list of RedactionJob validation error objects.

Response