Interface VerificationRequestEvent
- All Superinterfaces:
VerificationEvent
VerificationRequestEvent
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Dedicated Builderstatic class
The type of the event.static class
The verification method. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Getting builderDeprecated.Can be used to pass custom data in the request.getEvent()
The type of the event.getId()
The ID of the verification request.Get identityThe verification method.getPrice()
Get priceUsed to pass your own reference in the request for tracking purposes.
-
Method Details
-
getId
String getId()The ID of the verification request.- Specified by:
getId
in interfaceVerificationEvent
- Returns:
- id
-
getEvent
VerificationRequestEvent.EventEnum getEvent()The type of the event.- Returns:
- event
-
getIdentity
Identity getIdentity()Get identity- Specified by:
getIdentity
in interfaceVerificationEvent
- Returns:
- identity
-
getReference
String getReference()Used to pass your own reference in the request for tracking purposes.- Specified by:
getReference
in interfaceVerificationEvent
- Returns:
- reference
-
getCustom
String getCustom()Can be used to pass custom data in the request.- Specified by:
getCustom
in interfaceVerificationEvent
- Returns:
- custom
-
getMethod
VerificationRequestEvent.MethodEnum getMethod()The verification method.- Returns:
- method
-
getPrice
Price getPrice()Get price- Returns:
- price
-
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
Getting builder- Returns:
- New Builder instance
-