POST User/verify-2fa-opt-in

Verify the 2FA opt-in request by passing in the OTP and ProviderUserId.

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required

Body Parameters

Verify2FAOptInRequest

Name	Description	Type	Additional information
ProviderUserId	The provider user id of the mobile number registered for 2FA.	integer	Required
Otp	The one time password (OTP) sms-ed to the registered mobile number when you opt-in to 2FA.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "ProviderUserId": 1,
  "Otp": "sample string 2"
}

application/xml, text/xml

Sample:

<Verify2FAOptInRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProviderUserId>1</ProviderUserId>
  <Otp>sample string 2</Otp>
</Verify2FAOptInRequest>

Response Information

Resource Description

BaseResponseModel

Name	Description	Type	Additional information
StatusMessage	Status message from the response (if any).	string	None.
_links	Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server.	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusMessage": "sample string 1",
  "_links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<BaseResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
  </_links>
  <StatusMessage>sample string 1</StatusMessage>
</BaseResponseModel>