Capvant

Open a prefilled session

post
https://sandbox.capvant.com/partner/v1/sessions
POST
/sessions

Market, alpha-2 (GB, US).

Your id for the customer. Returned on the session and on every customer.* event.

business

Registered name.

Trading or doing-business-as name.

UK company number.

US EIN, 12-3456789. Returned masked.

State or country of incorporation.

Website URL.

Industry, from /enums/industries.

Business phone.

contact

First name.

Last name.

Phone, E.164.

Role in the business.

funding

Amount in major units of the market currency.

Purpose, from /enums/purposes.

trading

Monthly revenue in major units.

consent

Your record of the customer agreeing to share these details with Capvant. Required when contact or owners are sent.

Your id for the consent record.

https URL to send the customer back to when they finish or leave.

Send what you already hold about a customer: the business, the person you deal with, the owners, what they need. We answer with a launch link that opens the funding request with those details filled in and asks only for what is missing (asks_for). Give the link to the customer in your own product or email. Modelled on the way card and spend platforms let partners prefill an onboarding. Personal tax and identity numbers are refused; the lender step that needs one asks the customer directly.

Authorization

AuthorizationBearer <token>

An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Everything is optional except country. Send what you hold; the funding request asks the customer only for the rest. Contact or owner details need consent. Personal tax and identity numbers (SSN, ITIN, National Insurance, passport) are refused.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

Shell
curl -X POST "https://sandbox.capvant.com/sessions" \  -H "Content-Type: application/json" \  -d '{    "country": "GB"  }'
JSON
{  "id": "string",  "object": "session",  "status": "open",  "environment": "live",  "market": "UK",  "partner_customer_id": "string",  "launch_url": "string",  "expires_at": "2019-08-24T14:15:22Z",  "prefilled": [    "string"  ],  "asks_for": [    "string"  ],  "business": {    "legal_name": "string",    "company_number": "string",    "ein": "string"  },  "request": {    "id": "string",    "submitted_at": "2019-08-24T14:15:22Z"  },  "return_url": "string",  "created_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "submitted_at": "2019-08-24T14:15:22Z",  "cancelled_at": "2019-08-24T14:15:22Z"}