| name | eva-sentry-api |
| description | EVA Sentry API v1.2 reference for collisionspike, covering authentication, the eight endpoint families, the canonical twelve-field payload, image ordering, idempotency, and server-side submission. Use when changing EVA contracts, services/functions/eva-sentry, or any submission caller. |
EVA Sentry API v1.2
The field-level authority is the extracted current reference under docs/reference.
The implementation authority is the contract in packages/domain, the JSON schema
in contracts, and services/functions/eva-sentry. Read those before changing a
caller.
Authentication
- Base URL:
https://sentry.evasoftware.co.uk/api/.
- Mint a token with
POST /Connect/token using form fields Client_Id and
Client_Secret.
- Treat
expires_in as minutes and refresh with a safety buffer.
- Send
Authorization: Bearer <token> on every other request.
- Credentials are secret references and must never be logged, returned, or stored
in fixtures.
Endpoint families
POST /Instruction/Inspection creates an inspection instruction.POST /Claim/LocationUpdate updates inspection location.POST /Claim/AuthorityStatusUpdate updates repair authority.POST /Note/SubmitNote submits notes and ordered files.POST /Claim/Update updates claim lifecycle state.POST /Report/SubmitReport submits a completed report.GET /Report/GetAvailableReports lists released reports.GET /Report/GetReport?id={id} retrieves one report.
Check the current reference for exact target-key combinations and optional fields.
Canonical twelve-field core
Preserve this order and the existing JSON names:
- Work Provider (required)
- Vehicle Model
- Claimant Name
- Claimant Telephone
- Claimant Email Address
- Date of Loss (
DD/MM/YYYY)
- Date of Instruction (
DD/MM/YYYY)
- Accident Circumstances
- Inspection Address (six newline-separated lines, or
Image Based Assessment)
- VAT Status (
"", Yes, or No)
- Mileage
- Mileage Unit (
"", Miles, or Km)
Engineer allocation is not a submission field. The richer instruction body adds
claim identity, vehicle identity, location, damage, cost, and file fields without
changing this core.
Images and idempotency
- Send the overview with the full registration visible and the main-damage closeup
as the two previews, then send the full ordered set including those images.
- Exclude any image showing a person's reflection.
- Preserve sequence indices and filename extensions.
- Use the finalized payload hash as the idempotency key.
- The production caller is the orchestration service; the server-side EVA function
owns token lifecycle and credentials.
Keep EVA_API_ENABLED default-off until the approved environment is configured and
the contract tests pass. Record functional mismatches in their ticket instead of
changing an external route or body during unrelated cleanup.
