PATCH api/v1/admin/accounts/{id}/validate

This method validates an account using two codes that are sent to account's email address and mobile phone (Part 1 and Part 2). Both parts need to contain the correct verification code, you cannot use just one. Both verification code part will be submitted as one. It should look something like "1234ABCD","6949RTGF", etc.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the account.

globally unique identifier

Required

Body Parameters

The verification code

TwoSms.CustomerPortalRole.API.Admin.Accounts.AccountValidate
NameDescriptionTypeAdditional information
VerificationCode

Verfication code that is sent to account's email address and mobile phone.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "VerificationCode": "sample string 1"
}

application/xml, text/xml

Sample:
<AccountValidate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VerificationCode>sample string 1</VerificationCode>
</AccountValidate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Object
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {}
  }
}

application/xml, text/xml

Sample:
<ResponseOfObject xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail />
  </ResponseData>
</ResponseOfObject>