POST api/authentications/validate

Validates a given SMS authentication code, a valid code is considered used

Request Information

URI Parameters

None.

Body Parameters

SMS authentication code to validate

AuthenticationValidationRequest
NameDescriptionTypeAdditional information
Phone

Authenticating phone number

string

Required

Code

SMS authentication code to validate

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Phone": "sample string 1",
  "Code": "sample string 2"
}

Response Information

Resource Description

Validation result

AuthenticationValidationResponse
NameDescriptionTypeAdditional information
Valid

Whether the authentication code was valid for the given phone number

boolean

None.

Authentication

The used authentication, if the validation was valid

AuthenticationDTO

None.

Phone

Authenticating phone number

string

Required

Code

SMS authentication code to validate

string

Required

Response Formats

application/json, text/json

Sample:
{
  "Valid": true,
  "Authentication": {
    "ID": 1,
    "Phone": "sample string 2",
    "Created": "2019-08-19T15:33:09.2559862+00:00",
    "HasExpired": true,
    "Expires": "2019-08-19T15:33:09.2559862+00:00",
    "IsUsed": true,
    "Used": "2019-08-19T15:33:09.2559862+00:00"
  },
  "Phone": "sample string 2",
  "Code": "sample string 3"
}