Download OpenAPI specification:Download

Verifications start

Start new verification requests.

Start verification

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.

SecurityBasic or Application

Request

header Parameters

Accept-Language

string

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

Request Body schema: application/json
required

required	object (Identity) Specifies the type of endpoint that will be verified and the particular endpoint. `number` is currently the only supported endpoint type.
method required	string (VerificationMethod) The type of the verification request. seamless
reference	string Used to pass your own reference in the request for tracking purposes.
custom	string Can be used to pass custom data in the request.

Responses

200

A success response, or an Error.

Response Schema: application/json

id required	string Verification identifier used to query for status.
method required	string (VerificationMethod) The type of the verification request. sms
	Array of objects (Links)
	object The response contains the `template` of the SMS to be expected and intercepted.

post/verification/v1/verifications

Request samples

application/json

{"identity": {"type": "number",
"endpoint": "+46700000000"
},
"method": "sms"
}

Response samples