Verifications start

Start verification

Request

This method is used by the mobile and web Verification SDKs to start a verification. It can also be used to request a verification from your backend, by making an request.

Security

Basic or Application

Accept-Languagestring

In SMS Verification, value of Accept-Language header is used to determine the language of an SMS message.

Bodyapplication/jsonrequired

identityobject(Identity)required

Specifies the type of endpoint that will be verified and the particular endpoint. number is currently the only supported endpoint type.

methodstring(VerificationMethodStart)required

The type of the verification request.

Enum Value	Description
sms	Verification by SMS message with an OTP code.
flashcall	Verification by placing a flashVerificationResultEvent call (missed call) and detecting the incoming calling number (CLI).
callout	Verification by placing a PSTN call to the user's phone and playing an announcement, asking the user to press a particular digit to verify the phone number.
seamless	Data verification. Verification by accessing internal infrastructure of mobile carriers to verify if given verification attempt was originated from device with matching phone number.
whatsapp	Verification by WhatsApp message with an OTP code.

Example:"sms"

Discriminator

referencestring(VerificationEventReference)

Used to pass your own reference in the request for tracking purposes. Must be a unique value for each started verification request. The value must be encodable in the URL path segment. This value is passed to all events and returned from the status and report endpoints. The reference can be used to check the status of verifications, like with ID or identity.

customstring(VerificationEventCustom)

Can be used to pass custom data in the request. Will be passed to all events. Max length 4096 characters, can be arbitrary text data.

curl -i -X POST \
  -u '<username>:<password>' \
  https://verification.api.sinch.com/verification/v1/verifications \
  -H 'Accept-Language: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "identity": {
      "type": "number",
      "endpoint": "+46700000000"
    },
    "method": "sms"
  }'

Responses

A success response, or an Error.

Bodyapplication/json

idstringrequired

Verification identifier used to query for status.

Example:"1234567890"

methodstring(VerificationMethodStart)required

The type of the verification request.

Enum Value	Description
sms	Verification by SMS message with an OTP code.
flashcall	Verification by placing a flashVerificationResultEvent call (missed call) and detecting the incoming calling number (CLI).
callout	Verification by placing a PSTN call to the user's phone and playing an announcement, asking the user to press a particular digit to verify the phone number.
seamless	Data verification. Verification by accessing internal infrastructure of mobile carriers to verify if given verification attempt was originated from device with matching phone number.
whatsapp	Verification by WhatsApp message with an OTP code.

Example:"sms"

Discriminator

_linksArray of objects(Links)

smsobject

The response contains the template of the SMS to be expected and intercepted.

Response

{
  "id": "1234567890",
  "method": "sms",
  "_links": [
    { … }
  ],
  "sms": {
    "template": "Your verification code is {{CODE}}",
    "interceptionTimeout": 32,
    "codeType": "Numeric"
  }
}

We'd love to hear from you!