stable · api · 0.1.0

Stop optional account processing

POST /api/v1/privacy-requests/{privacyRequestId}/stop-processing

Capability Domain: Security Audit Privacy

Authentication

platformSession — Requires recent authentication.

Scope: None

Parameters and request body

X-Correlation-ID — header, optional
X-Correlation-ID schema
```
{
    "type": "string",
    "format": "uuid"
}
```
privacyRequestId — path, required
privacyRequestId schema
```
{
    "type": "string",
    "format": "uuid"
}
```

Responses and errors

Status	Description
`200`	Optional processing stopped and necessary processing explained
`401`	Invalid or revoked Project Credential
`403`	Project Credential lacks the required scope
`422`	Request violates the public contract

200 schema

200 response schema

{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "required": [
                "optional_processing",
                "necessary_processing",
                "necessary_purposes",
                "account_deletion_path"
            ],
            "properties": {
                "optional_processing": {
                    "type": "string",
                    "enum": [
                        "stopped"
                    ]
                },
                "necessary_processing": {
                    "type": "string",
                    "enum": [
                        "continues_while_account_is_active"
                    ]
                },
                "necessary_purposes": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "account_deletion_path": {
                    "type": "string"
                }
            }
        }
    }
}

401 schema

401 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

422 schema

422 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

200 example

200 response example

{
    "data": {
        "optional_processing": "stopped",
        "necessary_processing": "continues_while_account_is_active",
        "necessary_purposes": [
            "account_operation",
            "security_and_fraud_prevention",
            "service_delivery",
            "required_retention",
            "legal_obligations"
        ],
        "account_deletion_path": "/api/v1/platform-account"
    }
}

Idempotency

Reusing the correlation identifier for the same Privacy Request replays the result without repeating effects.