Partner API sandbox
Run the whole lead lifecycle on a sandbox key: nothing is routed, nothing is emailed, and every endpoint behaves as it will in production.
A sandbox key exercises every Partner API endpoint end to end. The environment is decided by the credential, not by the request, so there is no flag to forget and no way to send a test lead into the live panel by mistake.
What a sandbox key does
- Keys carry the
cv_pk_test_prefix. Anything minted from one, including bearer tokens, stays in the sandbox. - Leads created on a sandbox key are never routed to a funding provider, never emailed to anyone, and never seen outside your own account.
- Contact addresses on sandbox leads are rewritten to
@internal.invalid, a domain that cannot receive mail, so a wrong address in a fixture cannot reach a real person. - Every state change still fires its webhook event, so you can build and prove your event handling before go live.
The lifecycle worth rehearsing
Open a lead with POST /leads, then fill it in with PATCH /leads/{id} as your own form
collects more. A lead does not have to be complete to exist.
Add the people behind the business with PUT /leads/{id}/significant-persons, and upload
what the file needs with POST /leads/{id}/documents/{type}.
Submit it with POST /leads/{id}/submit. Until you submit, nothing is matched.
Read what came back with GET /leads/{id}/offers, and accept one with
POST /leads/{id}/offers/{offerId}/acceptance.
Subscribe to the events you care about with POST /webhook-subscriptions, and replay the
same lifecycle to see them arrive in order.
Getting a key
Sandbox keys are issued from your partner portal. Ask for one at
partnerships@capvant.com if your portal does not show
the Integration page yet. The playground on every reference page below sends to the
sandbox server, so pasting a cv_pk_test_ key into the X-API-Key field is safe.