hd

Verify a sign-in code

Changed on

Trade the emailed code, with the challenge it answers and the binding secret the start answered, for the customer's session. Every attempt is counted before the code is compared, and a challenge opens at most one session. Every refusal of the code is the same 400 PIN_INVALID: a wrong, spent, expired or another desk's code, a missing binding secret, a page that did not start the sign-in, and a desk whose customers sign in with Secure Identity.

post/hd/desks/{desk_id}/auth/pin/verify

Request

Path parameters

desk_idstring required

The desk, as its lookup answered it.

Headers

X-SV-Client'help-desk-portal' required

Names the portal. A request without it answers 400 CLIENT_HEADER_REQUIRED.

Request body

challenge_idstring required
binding_secretstring required
codestring required

The six digits the email carried.

Response

The customer's session and record.

Changes

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status