Package com.sinch.sdk.domains.verification.models.v1.status.response

Interface VerificationStatusResponseSms

All Superinterfaces:

VerificationStatusResponse

public interface VerificationStatusResponseSms
extends VerificationStatusResponse

SMS Verification Status Response

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VerificationStatusResponseSms.Builder	Dedicated Builder
static class	VerificationStatusResponseSms.MethodEnum	The method of the verification request.

Method Summary

Modifier and Type	Method	Description
static VerificationStatusResponseSms.Builder	builder()	Getting builder
String	getCountryId()	The ID of the country to which the verification was sent.
String	getId()	The unique ID of the verification request.
Identity	getIdentity()	Get identity
VerificationStatusResponseSmsPrice	getPrice()	Get price
VerificationStatusReason	getReason()	Get reason
String	getReference()	The reference ID that was optionally passed together with the verification request.
StatusSource	getSource()	Get source
VerificationStatus	getStatus()	Get status
Instant	getVerificationTimestamp()	The timestamp in UTC format.

Method Details

getId

String getId()

The unique ID of the verification request.

Specified by:

getId in interface VerificationStatusResponse

Returns:

id

getStatus

VerificationStatus getStatus()

Get status

Specified by:

getStatus in interface VerificationStatusResponse

Returns:

status

getReason

VerificationStatusReason getReason()

Get reason

Specified by:

getReason in interface VerificationStatusResponse

Returns:

reason

getReference

String getReference()

The reference ID that was optionally passed together with the verification request.

Specified by:

getReference in interface VerificationStatusResponse

Returns:

reference

getIdentity

Identity getIdentity()

Get identity

Specified by:

getIdentity in interface VerificationStatusResponse

Returns:

identity

getCountryId

String getCountryId()

The ID of the country to which the verification was sent.

Specified by:

getCountryId in interface VerificationStatusResponse

Returns:

countryId

getVerificationTimestamp

Instant getVerificationTimestamp()

The timestamp in UTC format.
Note: The formatting does not respect ISO-8601 and the returned value has the format YYYY-MM-DDThh:mm:ss.SSS. If you need to parse this value into a specific date object in your programming language, please append Z (Zulu time = UTC) at the end of the date value to match the ISO-8601 format: YYYY-MM-DDThh:mm:ss.SSSZ.

Specified by:

getVerificationTimestamp in interface VerificationStatusResponse

Returns:

verificationTimestamp

getPrice

VerificationStatusResponseSmsPrice getPrice()

Get price

Returns:

price

getSource

StatusSource getSource()

Get source

Returns:

source

builder

static VerificationStatusResponseSms.Builder builder()

Getting builder

Returns:

New Builder instance