Skip to main content

Verify phone number

POST /api/v1/Identity/verification/phone-number

Description​

This endpoint is used to verify phone number.

Headers:

  • Accept-Language: optional, allows changing default response message language, type: string

Content-Type:

  • text/plain
  • application/json
  • text/json

ApiKey:

  • No API key required

Request Body:

  • An object of the PhoneNumberRequest schema.

URL: /api/v1/Identity/verification/phone-number

Query Parameters:

  • None

params:

  • version: string, required

Response: The response is a "Success" status with a code of 200.

Error Codes:

  • 400: Bad Request
  • 404: Resource not found
  • 500: Internal server error

Example:

bashCopy codePOST /api/v1/Identity/verification/phone-number
Request Body:
    {
    "phoneNumber": "1234567890"
    }

Response:

jsonCopy codeHTTP/1.1 200 OK
    {
    "verificationStatus": "Valid"
    }

Headers​

Accept-Language Change default response message language from English(en). Available languages fr,en Content-Type application/json

Accept text/plain

Body raw(json)​

    {
    "number": "<string>"
    }