Skip to main content
POST
Verify a workspace invitation code

Headers

X-Signup-Invite
string

Supply a signed invitation using this header or an invite/invite_token query or body field. At least one is required; body/query values take precedence.

Query Parameters

invite
string

Supply a signed invitation using this header or an invite/invite_token query or body field. At least one is required; body/query values take precedence.

invite_token
string

Supply a signed invitation using this header or an invite/invite_token query or body field. At least one is required; body/query values take precedence.

Body

application/json

Validated request fields for this operation.

public_id
string<uuid>
required

Public setup-session UUID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

verification_code
string
required

Six-digit mailbox verification code; leading zeroes are significant.

Required string length: 6
Pattern: ^[0-9]{6}$
Example:

"012345"

Response

Operation result.

status
enum<string>
required
Available options:
success
Example:

"success"

data
object
required
session_token
string
required

Opaque resume credential; send in X-Workspace-Onboarding-Session. Never log it.

Required string length: 64
Example:

"example-session-token-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"