Skip to main content
POST
Create a hosted verification session

Authorizations

Authorization
string
header
required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Path Parameters

companyID
string
required

ID of the company.

Pattern: ^cmp_[0-9A-Za-z]{22}$

Body

application/json
shareholder
string
required

The owner whose identity document is being collected.

Pattern: ^sh_[0-9A-Za-z]{22}$
embed_origin
string

Frame this session inside your own site: the exact https origin (for example https://app.yourbrand.com) the page will be embedded on. The origin must first be registered under your hosted page's embed_origins. Omit it for an ordinary full-page session - the page then refuses to be framed anywhere.

Maximum string length: 255

Response

The session.

A short-lived hosted-upload session for one owner's identity document. Create one when you need a URL to hand (or redirect) your client to. The page carries your brand and your legal links from the verification page configuration. Sessions are repeatable - mint another when one expires.

object
enum<string>
required
Available options:
verification_session
company
string
required
Pattern: ^cmp_[0-9A-Za-z]{22}$
shareholder
string
required
Pattern: ^sh_[0-9A-Za-z]{22}$
url
string
required

Where to send your client. The URL is the credential - it authorizes exactly this owner's document upload, nothing else - so treat it like a secret and pass it over a secure channel.

expires_at
string<date-time>
required
livemode
boolean
required