GOgovernment-digital-service
Invites

Creates an invitation to allow self provisioning new service with Pay

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

Request

  • The document declares no server URL.
  • Auth
    none declared

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