stable · api · 0.1.0

Download a single-use Privacy Export

GET /api/v1/privacy-exports/{token}

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"
}
```
token — path, required
token schema
```
{
    "type": "string"
}
```

Responses and errors

Status	Description
`200`	Private no-store ZIP export
`401`	Invalid or revoked Project Credential
`403`	Project Credential lacks the required scope
`404`	No ready Privacy Export exists for this account and token
`410`	The single-use export is expired or already consumed

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"
                }
            }
        }
    }
}

Idempotency

The successful download consumes the token; retrying that token returns 410 Gone.