Skip to main content

Verify OTP SMS registration

POST 
https://$CUSTOM-DOMAIN/v3alpha/users/:userId/otp_sms/:otpSmsId/verify

Verify the OTP SMS registration with the provided code.

Request​

Path Parameters

    userId stringrequired

    unique identifier of the user.

    otpSmsId stringrequired

    unique identifier of the OTP SMS registration, which was returned in the add OTP SMS.

Body

required

    code stringrequired

    Possible values: non-empty and <= 200 characters

    Set the verification code generated during the add OTP SMS request.

Responses​

OTP SMS authenticator successfully verified

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
curl -L 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/otp_sms/:otpSmsId/verify' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "code": "SKJd342k"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
— pathrequired
Body required
{
  "code": "SKJd342k"
}
ResponseClear

Click the Send API Request button above and see the response here!