Error codes

simulate_requires_test_key

Test key required

HTTP 403

A simulation moves sandbox referrals only, so it needs a test key (sa_gap_test_... or sa_test_...).

The problem body

Sent as application/problem+json, with the request id in request_id and the X-Request-Id header. Branch on code: the error and detail sentences can change, and some operations add members of their own.

Example problem
{
  "error": "Test key required",
  "code": "simulate_requires_test_key",
  "type": "https://secondappraisal.com/developers/errors/simulate_requires_test_key",
  "title": "Test key required",
  "status": 403,
  "detail": "Test key required",
  "instance": "/api/gap/v1/referrals/<id>/simulate",
  "request_id": "req_4f9a2c7e1b8d4a6f9c3e2b1a7d5f8e0c"
}

Operations that can send it