permission_denied

Permission denied

HTTP 403

At launchOnly a v2 key is answered this way, and the portal issues v2 keys from launch.

The v2 key (sa_live_... or sa_test_...) doesn't hold the permission this operation needs, which x-required-permission names; error names it too. A v2 key holds only the permissions chosen when it was created. Create a key with the permission in the portal.

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": "Permission denied",
  "code": "permission_denied",
  "type": "https://secondappraisal.com/developers/errors/permission_denied",
  "title": "Permission denied",
  "status": 403,
  "detail": "Permission denied",
  "instance": "/api/gap/v1/referrals",
  "request_id": "req_4f9a2c7e1b8d4a6f9c3e2b1a7d5f8e0c"
}

Operations that can send it

POST /api/gap/v1/referrals · HTTP 403 · Create a referral
GET /api/gap/v1/referrals · HTTP 403 · List referrals
GET /api/gap/v1/referrals/{id} · HTTP 403 · Retrieve a referral
PATCH /api/gap/v1/referrals/{id} · HTTP 403 · Update or cancel a referral
POST /api/gap/v1/referrals/bulk · HTTP 403 · Create referrals in bulk
POST /api/gap/v1/referrals/{id}/simulate · HTTP 403 · Simulate a sandbox referral's next stepAt launchIt opens with the referral sandbox.
POST /api/gap/v1/referrals/{id}/attest · HTTP 403 · Attest a warm handoffAt launchIt opens with the referral sandbox.
GET /api/gap/v1/analytics · HTTP 403 · Savings and spend analytics
POST /api/gap/v1/plans/enrollments · HTTP 403 · Enroll one vehicle
GET /api/gap/v1/plans/enrollments · HTTP 403 · List your roster
GET /api/gap/v1/plans/enrollments/{id} · HTTP 403 · Retrieve one enrollment
PATCH /api/gap/v1/plans/enrollments/{id} · HTTP 403 · Cancel, swap the VIN, or edit contact details
POST /api/gap/v1/plans/enrollments/bulk · HTTP 403 · Enroll up to 500 vehicles
POST /api/gap/v1/plans/roster-sync · HTTP 403 · Reconcile your full roster
POST /api/gap/v1/plans/loss-notices · HTTP 403 · Tell us a member vehicle was declared a total loss
GET /api/gap/v1/plans/redemptions · HTTP 403 · Member consultations drawn against your roster
GET /api/gap/v1/plans/statements · HTTP 403 · Your monthly membership statements
POST /api/gap/v1/review-status/lookup · HTTP 403 · Look up review status by VIN, claim number or referenceAt launchIt opens with review records.
GET /api/gap/v1/referrals/{id}/review-record · HTTP 403 · Retrieve a referral's review recordAt launchIt opens with review records.