Configure outcome

post

https://api.ext-sandbox.fourthline.com/v2/testendpoint/workflows/{workflowId}

Use this endpoint to configure the expected outcome of an Identity Verification workflow in the Sandbox environment.

Create the workflow first, then call this endpoint before the workflow starts processing.

expectations is an object. Set its pending property. When the workflow status is pending, the statusCode in responseDetails determines the outcome.

This request stores that configuration. Call Get workflow status for the result.

Path Params

workflowId

uuid

required

The unique identifier of the workflow for which to configure the outcome.

Format: uuid

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Body Params

expectations

object

required

Set the pending property. When the workflow status is pending, the statusCode in responseDetails determines the outcome.

Headers

Authorization

string

required

Defaults to Bearer <access_token>

The access_token returned in your most recent Create access token response.

Cache-Control

string

Defaults to no-cache

To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to no-cache.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The response body is the string Processed. The workflow exists, and the expectations were validated and stored.

404Not Found. The response body is plain text: Workflow followed by the workflow ID and not found.

422Unprocessable Entity. The response body is a plain-text validation error message. Returned when the request body is invalid, including an unsupported check or a status code that cannot be applied.

502Bad Gateway. The response body is plain text: Workflow name could not be resolved for followed by the workflow ID.