Integrity Check API

Verify the SHA-256 hash of an archived email and all its attachments against the hashes stored at archival time.

Check Email Integrity

Check email integrity

GET

/v1/integrity/{id}

Verifies the SHA-256 hash of an archived email and all its attachments against the hashes stored at archival time. Returns per-item integrity results. Requires read:archive permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Parameters

Path Parameters

id*

UUID of the archived email to verify.

Type

string

Required

Example"550e8400-e29b-41d4-a716-446655440000"

Format

"uuid"

Responses

Integrity check results for the email and its attachments.

Content-Type

application/json

[

  

{

  

  

"type": "string",

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"filename": "invoice.pdf",

  

  

"isValid": true,

  

  

"reason": "string",

  

  

"storedHash": "a3f1b2c4...",

  

  

"computedHash": "a3f1b2c4..."

  

}

]

GET

/v1/integrity/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI