Documentation menu
ApiKeyLogResponse
Fields, types and constraints for the ApiKeyLogResponse public API model.
API key access audit record without secrets or key hashes.
Fields
| Field | Type | Constraint | Example | Visibility |
|---|---|---|---|---|
statusWhether the operation completed successfully. | boolean | — | false | Public contract |
_idAudit record id. | string | — | "example" | Public contract |
institutionIdAuthenticated tenant institution id. | string | — | "example" | Public contract |
apiKeyIdAPI key that made the request or is used as a filter. | string | nullable | "example" | Public contract |
apiKeySnapshotLimited API key snapshot without secrets or hashes. | object | nullable | {} | Public contract |
successWhether the request completed successfully. | boolean | — | false | Public contract |
errorTypeAPI key authentication or access error type. | string | enum: missing_key | invalid_key | inactive_key | inactive_institution | unapproved_institution | domain_restriction | ip_restriction | service_unavailable · nullable | "missing_key" | Public contract |
errorMessageSafe failure summary. | string | nullable | "example" | Public contract |
requestPathRequested API path. | string | — | "example" | Audit data |
requestUrlSafe request URL summary returned only by the detail endpoint. | string | nullable | "example" | Audit data |
requestMethodHTTP method. | string | — | "example" | Audit data |
requestHeadersRedacted header summary returned only by the detail endpoint. | object | — | {} | Audit data |
requestQueryRedacted query summary returned only by the detail endpoint. | object | — | {} | Audit data |
requestBodyRedacted body summary returned only by the detail endpoint. | object | — | {} | Audit data |
hostRequest host returned only by the detail endpoint. | string | nullable | "example" | Public contract |
originOrigin header reported by the request. | string | nullable | "example" | Audit data |
refererReferer header reported by the request. | string | nullable | "example" | Audit data |
userAgentSafely stored request user-agent. | string | nullable | "example" | Audit data |
ipRequest IP shown in the tenant report. | string | nullable | "example" | Personal context |
responseTimeRequest duration in milliseconds. | number | — | 0 | Public contract |
expiresAtTime when the audit record expires. | string | format: date-time · nullable | "2026-07-14T12:00:00Z" | Public contract |
createdAtRecord creation time. | string | format: date-time | "2026-07-14T12:00:00Z" | Public contract |
updatedAtRecord update time. | string | format: date-time | "2026-07-14T12:00:00Z" | Public contract |
Machine-readable schema
The model is published under the same name in the JSON Schema bundle.
JSON SchemaDecision boundary
An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.