Value-verification

Check if the customer has or knows a shared value.

Provides a simple input experience for a user to enter in a value that is known to the merchant and customer, like an account number. This is useful when you want to be sure the holder of the information is the one completing the business process.

No products are required to use this action.

This action pairs well with the following actions.

State

No value is captured, resolution confirms knowledge of the provided value by the customer.

Union

No submit button will render when unioned to another action.

Macro level details for how union attribute behaves can be found within the Union documentation.

Features (required)

NameTypeDescriptionRules
titlestring(required) Title of the verification
Examples: "Verification".
MinLength: 1
descriptionstring(required) Description of the verification process
Examples: "Please enter the verification code provided by the merchant.".
MinLength: 1

Context (required)

NameTypeDescriptionRules
valuestring(required) Value that the customer is expected to know.
Examples: "xxxx".
MaxLength: 1024
MinLength: 1

Example

Below is an example payload for adding an action to a business process or blueprint.

{
    "type": "value-verification",
    "union": 0,
    "context": {
        "value": "xxxx"
    },
    "features": {
        "title": "Verification",
        "description": "Please enter the verification code received."
    }
}