Postman collection
Import both APIs into Postman from the OpenAPI documents this hub is generated from.
Both APIs are published as OpenAPI 3.1 documents, and every page in the API Reference is generated from them. Import the same documents into Postman, Insomnia or your own client and you get the identical set of operations.
Import
Download the document for the API you are integrating.
- Lender API:
openapi.json - Partner API:
openapi-partner.json
In Postman choose Import, then Files, then the document you downloaded. Postman builds a collection with one request per operation and the request bodies already shaped.
Add a collection variable named apiKey holding your sandbox key, and set the
collection authorization to an API key in the header named X-API-Key.
Pick the Sandbox server in the collection's variables before your first send, so a test never lands on production.
Request samples
Every operation page renders the same request in the language you pick, and the playground sends it to the sandbox server.
Servers
Lender API
| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.capvant.com/v1 |
| Production | https://api.capvant.com/v1 |
Partner API
| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.capvant.com/partner/v1 |
| Production | https://api.capvant.com/partner/v1 |
Getting a sandbox key
Sandbox keys are issued from the Lender Hub under Team, then API keys. A sandbox key
carries the cv_test_ prefix, only ever sees test deals, and can be revoked
without touching your live integration. The playground on every reference page sends to
the sandbox server, so pasting that key into the X-API-Key field is safe.