Your first API call
From a key to a deal on screen in one sitting, with the calls in order.
The whole loop (create a key, confirm it works, read real data) in under five minutes. This walks the Lender API; the Partner API is identical with a cv_pk_ key and the /partner/v1 base URL.
- 1get/ping
Prove the key authenticates and see which environment it resolved to.
Hands you your organisation name, and sandbox or live
- 2
- 3get/deals/{ref}
Read one deal in full, including the market object for its country.
Hands you the complete deal
1. Create a key
In the Lender Hub, go to Team to API keys and create one. The full key is shown exactly once. Copy it into a secret store or environment variable now.
export CAPVANT_API_KEY=cv_live_4f8a...c212. Ping the API
Confirm the key is live before building anything else on top of it.
curl https://api.capvant.com/v1/ping \
-H "X-API-Key: $CAPVANT_API_KEY"A 401 here means the key is missing, mistyped, or revoked. See Authentication.
3. List your deals
curl "https://api.capvant.com/v1/deals?limit=5" \
-H "X-API-Key: $CAPVANT_API_KEY"Empty deals? That's normal for a brand-new lane. Create a few records to work against with the sandbox instead of waiting for real referrals.
What's next
- Walk the full field list on List deals and Retrieve a deal.
- Stop polling: set up webhooks.
- Build against fake data safely with the sandbox.