Package com.sinch.sdk.domains.verification

Interface VerificationsService

public interface VerificationsService

Verifications Service

Start new verification requests and report on existing verification requests.

Since:

1.0

See Also:

https://developers.sinch.com/docs/verification/api-reference/verification/tag/Verifications///

Method Summary

Modifier and Type	Method	Description
VerificationReport	report(Identity identity, VerificationReportRequestParameters parameters)	Report a verification using Identity
VerificationReport	report(VerificationId id, VerificationReportRequestParameters parameters)	Report the received verification code to verify it, using the Verification ID of the Verification request
StartVerificationResponse	start(StartVerificationRequestParameters parameters)	Start verification

Method Detail

start

StartVerificationResponse start(StartVerificationRequestParameters parameters)

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 a request.

Parameters:

parameters - Parameters to be used to start verification

Returns:

Verification response

Since:

1.0

report

VerificationReport report(Identity identity,
                          VerificationReportRequestParameters parameters)

Report a verification using Identity

Report the received verification code to verify it, using the identity of the user (in most cases, the phone number). For an SMS PIN verification or Phone Call verification, this is the OTP code. For flashcalls, this is the CLI.

Parameters:

identity - Only number identity is supported

parameters - Parameters to be used to get report

Returns:

Verification report response

Since:

1.0

report

VerificationReport report(VerificationId id,
                          VerificationReportRequestParameters parameters)

Report the received verification code to verify it, using the Verification ID of the Verification request

Parameters:

id - Id returned from start verification

parameters - Parameters to be used to get report

Returns:

Verification report response

Since:

1.0