Developers

The partner API is how an institution in the Valuation Review Program works with us from its own systems: refer a borrower whose vehicle was declared a total loss, follow the referral through its milestones, and read your program's results. The GAP Provider Program and Lender Program pages describe the program itself.

  • Quickstart

    Create a key in the portal, make your first call to GET /api/gap/v1/me, then create and follow a referral with retries that are safe to repeat.

  • API reference

    Every operation, parameter, response, error code and webhook event in the partner API, generated from the contract the API runs on.

  • Sandbox

    At launch, test keys reach sandbox referrals: made-up borrowers, simulated lifecycle steps and test webhooks, with nothing sent to a borrower and nothing billed.

  • Webhook verification

    How every webhook delivery is signed, how to verify X-SecondAppraisal-Signature and the Standard Webhooks headers, and how retries work.

  • Security profile

    How the partner API authenticates calls and signs webhooks: key formats and permissions, signed requests with their algorithms and window, signing secrets, and how long each record is kept.

  • Error codes

    Every code a partner API refusal carries, with its HTTP status and what to do; each problem's type URL points to its page here.

The essentials

Every call goes to https://secondappraisal.com/api/gap/v1 over HTTPS. Bodies are JSON, money is integer cents, and timestamps are ISO 8601 in UTC. Authenticate with the key you create on the portal's API & Webhooks page, sent as Authorization: Bearer <key>. Keys, sandbox keys included, are issued only to institutions with a portal account.

At launchThe portal issues v2 keys that hold only the permissions you choose, and an institution can register its own Ed25519 or ECDSA P-256 public key and sign each request instead of sending a key.

We add operations, response fields and webhook event types over time: ignore fields and event types you don't recognise.

Machine-readable

Fetch the document
curl https://secondappraisal.com/api/gap/v1/openapi

Questions about the API or the program: contact us, and quote the request_id of any call you ask about.