Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-correlation-id
string

Caller-supplied correlation ID; the server generates one when omitted.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]+$

Response

Successful response.

code
string
required
Pattern: ^[a-z0-9]{12,24}$
shareUrl
string<uri>
required
policy
object
required
stats
object
required
claim
object | null
required
referrals
object[]
required
Maximum array length: 100