Error

A valid request URL is required to generate request examples

{
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Customer teams

Accept an invitation

Takes two proofs, not one. The token proves the invitation — that this seat was offered to this address. The contact session proves the person. So the invited address must be an identity of the signed-in contact: a forwarded link seats nobody (invitation_not_yours).

An email becomes an identity when something makes it one — hosted sign-up, a magic link, a six-digit code, or your own server calling POST /v1/contacts with it. Passing an address to /v1/boot in federated mode deliberately does not.

An invitation belongs to one environment. A contact of the other one is refused with the same invalid_token as an expired link.

POST

contact

invitations

Error

A valid request URL is required to generate request examples

{
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Authorizations

Authorization

string

header

required

A contact session token, uk_ct_…. Belongs to one of the developer's own users, and reads only that user's data.

Body

application/json

token

string

required

The uk_cin_… token from the email.

Response

Joined.

customer

object

Show child attributes

Resend an invitation List webhook endpoints

⌘I

Overview

Endpoints

Accept an invitation

Authorizations

Body

Response