Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create a redaction job Preview

Privacy
Redaction Job
Create a redaction job

Creates a redaction job. When a job is created, it will start to validate.

Parameters

  • objectsobjectRequired

    The objects to redact. These root objects and their related ones will be validated for redaction.

  • validation_behaviorenum

    Determines the validation behavior of the job. Default is error.

    Possible enum values
    error

    The job will generate a validation error for every object that cannot be redacted. If there are any errors, all of them will need to be resolved before the job can run.

    fix

    The job will attempt to fix validation errors whenever possible. Some objects cannot be automatically fixed and will need to be resolved before the job can run.

Returns

Returns the newly created RedactionJob object.

POST /v1/privacy/redaction_jobs
curl https://api.stripe.com/v1/privacy/redaction_jobs \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-05-28.preview" \
  -d validation_behavior=error \
  -d "objects[customers][]"=cus_123
Response
{
  "id": "prj_123",
  "object": "privacy.redaction_job",
  "created": 1234567890,
  "livemode": true,
  "status": "validating",
  "validation_behavior": "error"
}