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.
- Credentials and signing
API key formats and lifetimes, how to sign a request with your own Ed25519 or ECDSA P-256 key, and test vectors to check your signer against.
- API reference
Every operation, parameter, response, error code and webhook event in the partner API, generated from the contract the API runs on.
- Data dictionary
Every field and parameter you send or receive, with its type and the class of data it carries, generated from the contract the API runs on.
- Pagination
How each list operation pages: its default and largest page size, the cursor you send back, and how to read every page.
- Rate limits
How many calls each key may make a minute in each rate class, the RateLimit and Retry-After headers, and how to back off.
- Versioning and changelog
How the partner API is versioned, what may change within a version, how a deprecation is announced, and what each version changed.
- 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, how retries work, and how a new endpoint passes its verification challenge.
- 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.
- Your responsibilities
The controls each institution runs on its side: keys kept in a secrets manager, departed staff removed, webhooks verified, contacts kept current, payment changes confirmed out of band.
- 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.
- Support
Where to send a question about the API or the program, what to include, and where to report a security concern or a credential you think is compromised.
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
- /api/gap/v1/openapi: the OpenAPI 3.1 document, generated from the contract the API runs on. Add
?oas=3.0for an OpenAPI 3.0.3 copy. - /.well-known/api-catalog: the RFC 9727 catalog of the APIs this site publishes.
curl https://secondappraisal.com/api/gap/v1/openapiQuestions about the API or the program: email business@secondappraisal.com, and quote the request_id of any call you ask about.