CLclinicos
Widget

Verify code from email

Changed on
post/public/widget/auth/verify

Request

Request body

sessionIdstring required
clinicIdstring required
codestring required

The 6-digit verification code sent to the user's email

emailstring required

The email address that the code was sent to

Response

OK

successboolean
tooManyAttemptsboolean

True on the wrong guess that used up the code's last attempt. The code is gone at that point, so the widget should send the user to request a new one rather than retry.

clientIdstring nullable
clientNamestring nullable
clientEmailstring nullable
clientPhonestring nullable

Example response

{
  "patients": [
    {
      "species": "Cat",
      "breed": "Siamese",
      "sex": "Male"
    }
  ]
}

Changes

  • d58b40cfca93Revision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)