Secure OTV

Secure OTV Initiate - US This page documents the Secure OTV module, including its variants, capabilities, and the result values it returns.

Secure OTV: US Secure OTV Initiate

Capabilities

The module returns the following capabilities.

OTV initiation status

OTV Initiation Status

Code	Label	Description
`initiated`	Initiated	Transaction initiated successfully

OTV SMS status

SMS delivery status from the Initiate step (present only when ExpectID attempted SMS delivery)

Code	Label	Description
`SENT`	SMS Sent	SMS Sent
`FAILED`	SMS Failed	SMS Failed
`FAILED_OPT_OUT`	SMS Failed - Opt Out	SMS Failed - Opt Out

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Success`	OTV Initiation Status isAnyOf `initiated`	The verification transaction was initiated successfully.
`Error`	Default (no conditions matched)	The verification transaction could not be initiated.

Input payload

The following is a sample payload used to submit data to the US Secure OTV Initiate module for processing.

JSON

{
  "equalToFile": "us-secure-otv-initiate-error-data.json"
}

Field	Required	Description
`MobilePhone`	Yes	The mobile phone number to send the verification SMS to.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "status": "error",
    "outcome": "Error"
  }
}

Secure OTV: US Secure OTV Status

Secure OTV Status - US

Capabilities

The module returns the following capabilities.

OTV request status

OTV Transaction Request Status

Code	Label	Description
`pending`	Pending	Transaction is in process
`passed`	Passed	Transaction passed verification
`failed`	Failed	Transaction failed verification

OTV SMS status

SMS delivery status from the Status step (present when ExpectID reports SMS delivery state at time of status check)

Code	Label	Description
`SENT`	SMS Sent	SMS Sent
`FAILED`	SMS Failed	SMS Failed
`FAILED_OPT_OUT`	SMS Failed - Opt Out	SMS Failed - Opt Out

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Verified`	OTV Request Status isAnyOf `passed`	The subject passed verification.
`Not Verified`	OTV Request Status isAnyOf `failed`	The subject failed verification.
`Pending`	OTV Request Status isAnyOf `pending`	Verification is still in progress. Check the status again later.
`Error`	—	The status of the verification transaction could not be retrieved.
`Manual Review`	Default (no conditions matched)	No status condition matched, so the transaction is referred for manual review.

Input payload

The following is a sample payload used to submit data to the US Secure OTV Status module for processing.

JSON

{
  "equalToFile": "us-secure-otv-status-error-data.json"
}

Field	Required	Description
`PhoneVerification`	Yes	The reference for the verification transaction to check the status of.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "status": "error",
    "outcome": "Error"
  }
}

Get Started

Platform

API-first integration

Hosted journey

Digital IDs

Resources

Secure OTV: US Secure OTV Initiate

Capabilities

OTV initiation status

OTV SMS status

Default outcomes

Input payload

Sample response

Secure OTV: US Secure OTV Status

Capabilities

OTV request status

OTV SMS status

Default outcomes

Input payload

Sample response

​Secure OTV: US Secure OTV Initiate

​Capabilities

​OTV initiation status

​OTV SMS status

​Default outcomes

​Input payload

​Sample response

​Secure OTV: US Secure OTV Status

​Capabilities

​OTV request status

​OTV SMS status

​Default outcomes

​Input payload

​Sample response

Secure OTV: US Secure OTV Initiate

Capabilities

OTV initiation status

OTV SMS status

Default outcomes

Input payload

Sample response

Secure OTV: US Secure OTV Status

Capabilities

OTV request status

OTV SMS status

Default outcomes

Input payload

Sample response