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

Update a redaction jobPreview

Updates the properties of a redaction job without running or canceling the job.

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

Parameters

  • jobstringRequired

    RedactionJob object identifier

  • 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 RedactionJob object with the updated changes.

POST /v1/privacy/redaction_jobs/:id
curl https://api.stripe.com/v1/privacy/redaction_jobs/prj_123 \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d validation_behavior=error
Response
{
  "id": "prj_123",
  "object": "privacy.redaction_job",
  "created": 1234567890,
  "livemode": true,
  "status": "failed",
  "validation_behavior": "fix"
}

Retrieve a redaction jobPreview

Retrieves the details of a previously created redaction job.

Parameters

  • jobstringRequired

    RedactionJob object identifier

Returns

Returns the RedactionJob object.

GET /v1/privacy/redaction_jobs/:id
curl https://api.stripe.com/v1/privacy/redaction_jobs/prj_123 \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "prj_123",
  "object": "privacy.redaction_job",
  "created": 1234567890,
  "livemode": true,
  "status": "ready",
  "validation_behavior": "error"
}

List all redaction jobsPreview

Returns a list of redaction jobs.

Parameters

No parameters.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

Returns a list of RedactionJob objects.

GET /v1/privacy/redaction_jobs
curl https://api.stripe.com/v1/privacy/redaction_jobs \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "object": "list",
  "url": "/v1/privacy/redaction_jobs",
  "has_more": false,
  "data": [
    {
      "id": "prj_123",
      "object": "privacy.redaction_job",
      "created": 1234567890,
      "livemode": true,
      "status": "validating",
      "validation_behavior": "error"
    },
    {
      "id": "prj_456",
      "object": "privacy.redaction_job",
      "created": 1234567890,
      "livemode": true,
      "status": "success",
      "validation_behavior": "fix"
    }
  ]
}

Cancel a redaction jobPreview

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Parameters

  • jobstringRequired

    RedactionJob object identifier

Returns

Returns the RedactionJob object if successful. Otherwise, returns an error.

POST /v1/privacy/redaction_jobs/:id/cancel
curl -X POST https://api.stripe.com/v1/privacy/redaction_jobs/prj_123/cancel \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "prj_123",
  "object": "privacy.redaction_job",
  "created": 1234567890,
  "livemode": true,
  "status": "canceling",
  "validation_behavior": "error"
}

Run a redaction jobPreview

Run a redaction job in a ready status.

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

Parameters

  • jobstringRequired

    RedactionJob object identifier

Returns

Returns the RedactionJob object if successful. Otherwise, returns an error.

POST /v1/privacy/redaction_jobs/:id/run
curl -X POST https://api.stripe.com/v1/privacy/redaction_jobs/prj_123/run \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "prj_123",
  "object": "privacy.redaction_job",
  "created": 1234567890,
  "livemode": true,
  "status": "redacting",
  "validation_behavior": "error"
}