Skip to main content

Documentation Index

Fetch the complete documentation index at: https://spendguard.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint

GET /v1/checks/{check_id}
Authentication: Required (X-API-Key header)

Path Parameters

ParameterTypeDescription
check_idstringThe check ID to retrieve (format: chk_...)

Example Request

curl https://spendguardapi.com/v1/checks/chk_a1b2c3d4e5f6 \
  -H "X-API-Key: $SPENDGUARD_API_KEY"

Response — 200 OK

{
  "check_id": "chk_a1b2c3d4e5f6",
  "decision": "block",
  "confidence": "high",
  "reason_code": "r1",
  "message": "Amount $750.00 exceeds the policy limit of $500.00.",
  "violated_rule_id": "r1",
  "violated_rule_description": "Block refunds over $500",
  "policy_version": 1,
  "next_step": null,
  "latency_ms": 8,
  "timestamp": "2026-04-03T12:00:00Z"
}
The response contains the same fields as the original check response.

Error Responses

StatusCodeWhen
401unauthorizedMissing or invalid API key
404check_not_foundNo check exists with this ID
500internal_errorServer error