Developer centerv1.0.0
Documentation menu
Data models

ApiKeyLogResponse

Fields, types and constraints for the ApiKeyLogResponse public API model.

API key access audit record without secrets or key hashes.

Fields

FieldTypeConstraintExampleVisibility
status

Whether the operation completed successfully.

booleanfalsePublic contract
_id

Audit record id.

string"example"Public contract
institutionId

Authenticated tenant institution id.

string"example"Public contract
apiKeyId

API key that made the request or is used as a filter.

stringnullable"example"Public contract
apiKeySnapshot

Limited API key snapshot without secrets or hashes.

objectnullable{}Public contract
success

Whether the request completed successfully.

booleanfalsePublic contract
errorType

API key authentication or access error type.

stringenum: missing_key | invalid_key | inactive_key | inactive_institution | unapproved_institution | domain_restriction | ip_restriction | service_unavailable · nullable"missing_key"Public contract
errorMessage

Safe failure summary.

stringnullable"example"Public contract
requestPath

Requested API path.

string"example"Audit data
requestUrl

Safe request URL summary returned only by the detail endpoint.

stringnullable"example"Audit data
requestMethod

HTTP method.

string"example"Audit data
requestHeaders

Redacted header summary returned only by the detail endpoint.

object{}Audit data
requestQuery

Redacted query summary returned only by the detail endpoint.

object{}Audit data
requestBody

Redacted body summary returned only by the detail endpoint.

object{}Audit data
host

Request host returned only by the detail endpoint.

stringnullable"example"Public contract
origin

Origin header reported by the request.

stringnullable"example"Audit data
referer

Referer header reported by the request.

stringnullable"example"Audit data
userAgent

Safely stored request user-agent.

stringnullable"example"Audit data
ip

Request IP shown in the tenant report.

stringnullable"example"Personal context
responseTime

Request duration in milliseconds.

number0Public contract
expiresAt

Time when the audit record expires.

stringformat: date-time · nullable"2026-07-14T12:00:00Z"Public contract
createdAt

Record creation time.

stringformat: date-time"2026-07-14T12:00:00Z"Public contract
updatedAt

Record update time.

stringformat: 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 Schema

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.