Invites

Creates an invitation to allow self provisioning new service with Pay

post/v1/api/invites/create-self-registration-invite

Request body

emailstring email required

Example request

{
  "email": "example@example.gov.uk"
}

Response

Created

attempt_counterinteger

disabledboolean

emailstring

expiredboolean

inviteLinkstring

is_invite_to_join_serviceboolean

otp_keystring

password_setboolean

rolestring

telephone_numberstring

user_existboolean

Example response

{
  "_links": [
    {
      "href": "https://an.example.link",
      "method": "GET",
      "rel": "self"
    }
  ],
  "email": "example@example.gov.uk",
  "is_invite_to_join_service": true,
  "otp_key": "ABC123",
  "role": "view-only",
  "telephone_number": "+440787654534"
}

Changes

Changed in 8 of the 53 revisions of this API.324

Jan 20, 202661835ad90a331See the full diff
- ▲
  the email request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Nov 25, 202561821d66cdcb1See the full diff
- ○
  the email request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
May 20, 20250a185c6297891See the full diff
- ▲
  the email request property type/format changed from string/ to string/email
  request-property-type-changed
Apr 10, 2025e1deccce0b141See the full diff
- ▲
  the email request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Dec 19, 20226a7bd1eb62a71See the full diff
- ●
  removed the optional property type from the response with the 201 status
  response-optional-property-removed
Dec 15, 20225163f2c9ccc311See the full diff
- ●
  removed the optional property invite_to_join_service from the response with the 201 status
  response-optional-property-removed
- ○
  added the optional property is_invite_to_join_service to the response with the 201 status
  response-optional-property-added
Dec 13, 2022566e66065caa1See the full diff
- ○
  added the optional property invite_to_join_service to the response with the 201 status
  response-optional-property-added
Dec 12, 2022df693274547d1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history