GOgovernment-digital-service
Invites

Re-provision otp secret key for the invite

Changed on
post/v1/api/invites/{code}/reprovision-otp

Request

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

Path parameters

codestring required

Response

OK

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

  • 6a7bd1eb62a7Revision changes
    • warning

      removed the optional property from the response with the status

  • 5163f2c9ccc3Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status