Create a hosted verification session
Mints a fresh URL for the hosted identity-document page, for one owner of this company. Live mode only - the hosted page collects a real identity document. Test companies rehearse verification through the sandbox simulate endpoint instead. Requires the verification page to be configured first (your display name and privacy policy - the page presents them to your client). Refused when the owner’s document is already received.
Authorizations
Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.
Path Parameters
ID of the company.
^cmp_[0-9A-Za-z]{22}$Body
The owner whose identity document is being collected.
^sh_[0-9A-Za-z]{22}$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.
255Response
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.
verification_session ^cmp_[0-9A-Za-z]{22}$^sh_[0-9A-Za-z]{22}$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.