Package com.sinch.sdk.domains.verification.models.v1.sinchevents

Interface VerificationStartEvent

All Superinterfaces:

VerificationSinchEvent

public interface VerificationStartEvent
extends VerificationSinchEvent

VerificationStartEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VerificationStartEvent.Builder	Dedicated Builder
static class	VerificationStartEvent.EventEnum	The type of the event.

Method Summary

Modifier and Type	Method	Description
static VerificationStartEvent.Builder	builder()	Getting builder
List<String>	getAcceptLanguage()	Deprecated.
String	getCustom()	Can be used to pass custom data in the request.
String	getId()	The ID of the verification request.
Identity	getIdentity()	Get identity
VerificationMethod	getMethod()	Get method
Price	getPrice()	Get price
String	getReference()	Used to pass your own reference in the request for tracking purposes.

Method Details

getId

String getId()

The ID of the verification request.

Field is required

Specified by:

getId in interface VerificationSinchEvent

Returns:

id

getMethod

VerificationMethod getMethod()

Get method

Field is required

Specified by:

getMethod in interface VerificationSinchEvent

Returns:

method

getIdentity

Identity getIdentity()

Get identity

Field is required

Specified by:

getIdentity in interface VerificationSinchEvent

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 VerificationSinchEvent

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 VerificationSinchEvent

Returns:

custom

getPrice

Price getPrice()

Get price

Returns:

price

getAcceptLanguage

@Deprecated
List<String> getAcceptLanguage()

Deprecated.

Allows you to set or override if provided in the API request, the SMS verification content language. Only used with the SMS verification method. The content language specified in the API request or in the callback can be overridden by carrier provider specific templates, due to compliance and legal requirements, such as US shortcode requirements (pdf).

Returns:

acceptLanguage

builder

static VerificationStartEvent.Builder builder()

Getting builder

Returns:

New Builder instance