Reports whether the supplied activation code would admit a sign-up on the calling tenant.

POST

/api/v1/provision/activations/admission/check

curl --request POST \
  --url https://example.com/api/v1/provision/activations/admission/check \
  --header 'Content-Type: application/json' \
  --data '{ "activationCode": "example", "email": "example" }'

Request Body^required

Whether an activation code entitles its holder to create an account on this tenant. The code is bound to the address it was issued to, so the registrant’s address travels with it.

object

activationCode

required

string

email

required

string

Example^generated

{
  "activationCode": "example",
  "email": "example"
}

Whether an activation code entitles its holder to create an account on this tenant. The code is bound to the address it was issued to, so the registrant’s address travels with it.

object

activationCode

required

string

email

required

string

Example^generated

{
  "activationCode": "example",
  "email": "example"
}

Whether an activation code entitles its holder to create an account on this tenant. The code is bound to the address it was issued to, so the registrant’s address travels with it.

object

activationCode

required

string

email

required

string

Example^generated

{
  "activationCode": "example",
  "email": "example"
}

Responses

200

OK

Media typeapplication/json

One boolean, deliberately. Every other activation surface distinguishes not-found from expired from wrong-authentication-level from seats-full, which makes it an oracle for which codes exist. This endpoint is reachable in service of an anonymous form, so it says only yes or no.

object

admitted

required

boolean

Example^generated

{
  "admitted": true
}

400

Bad Request

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}