Skip to main content
Redeem a one-time activation code for an org token

Authorizations

x-partner-key
string
header
required

Partner API key: vpk_live_ + 48 lowercase hex. Server-side only.

Headers

x-vort-lang
enum<string>

Language of notices and messages. Defaults to the partner default.

Available options:
he,
en

Body

application/json
code
string
required

As typed, e.g. VORT-7KQM-3XHP. Case, spaces and dashes are normalized.

Example:

"VORT-7KQM-3XHP"

external_id
string
required

Your id for this customer. Unique per partner.

Minimum string length: 1

Response

Redeemed. org_token is returned once; store it server-side.

organization_id
string<uuid>
required
org_token
string
required

Returned once. Store server-side, encrypted.

Pattern: ^vot_[0-9a-f]{48}$
organization_name
string
required