Package com.sinch.sdk.domains.verification.models.v1.start.request

Interface VerificationStartRequestSms

All Superinterfaces:

VerificationStartRequest

public interface VerificationStartRequestSms
extends VerificationStartRequest

VerificationStartRequestSms

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VerificationStartRequestSms.Builder	Dedicated Builder

Method Summary

Modifier and Type	Method	Description
static VerificationStartRequestSms.Builder	builder()	Getting builder
String	getAcceptLanguage()	In SMS Verification, value of Accept-Language header is used to determine the language of an SMS message.
SmsCodeType	getCodeType()	Get codeType
String	getCustom()	Can be used to pass custom data in the request.
String	getExpiry()	The expiration time for a verification process is represented in the format HH:MM:SS .
Object	getExtraOption(String key)	Return the additional "smsOptions" with the specified name.
Identity	getIdentity()	Get identity
String	getReference()	Used to pass your own reference in the request for tracking purposes.

Method Details

getIdentity

Identity getIdentity()

Get identity

Field is required

Specified by:

getIdentity in interface VerificationStartRequest

Returns:

identity

getReference

String getReference()

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.

Specified by:

getReference in interface VerificationStartRequest

Returns:

reference

getCustom

String getCustom()

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.

Specified by:

getCustom in interface VerificationStartRequest

Returns:

custom

getCodeType

SmsCodeType getCodeType()

Get codeType

Returns:

codeType

getExpiry

String getExpiry()

The expiration time for a verification process is represented in the format HH:MM:SS .

Returns:

expiry

getAcceptLanguage

String getAcceptLanguage()

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

Returns:

acceptLanguage

getExtraOption

Object getExtraOption(String key)

Return the additional "smsOptions" with the specified name.

Parameters:

key - the name of the property

Returns:

the additional property with the specified name

builder

static VerificationStartRequestSms.Builder builder()

Getting builder

Returns:

New Builder instance