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

Interface VerificationStartRequestData

All Superinterfaces:

VerificationStartRequest

public interface VerificationStartRequestData
extends VerificationStartRequest

VerificationStartRequestData

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VerificationStartRequestData.Builder	builder()	Getting builder
String	getCustom()	Can be used to pass custom data in the request.
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

builder

static VerificationStartRequestData.Builder builder()

Getting builder

Returns:

New Builder instance