Retrieving Results

You can check the status and retrieve the results of a Flow using the /status API endpoint.

Endpoint

/api/fraud-flows/status/{{api_key}}{{link_request_id}}

Request Parameters

Field	Description	Required
api_key	The API key associated with the Flow you intend to retrieve the status of. This is likely your primary API key.	Yes
link_request_id	The request ID of the link you intend to retrieve the status of.	Yes
link_request_id	On success	The link request ID.
link	On success	The full link URL.

Response Parameters

Field	Description	Returned
success	Whether or not the status request succeeded.	Always
message	"Success" or an error message if success returned false .	Always
workflow	The name of the fraud Flow.	On success
flow_request_id	The Flow request ID.	On success
link_request_id	The link request ID.	On success
sessions	An array of Sessions that have been created off of the given link. An empty array is returned if no Sessions exist yet. An example of a `session` object is detailed below.	On success

Sessions Object

Field	Description	Returned
state	The state of the Session. - `IN_PROGRESS` - `COMPLETED` - `EXPIRED`	On success and a Session exists.
results	An array of results associated with this Session. Each result object is for a specific Step run in a specific Session. An example of a `results` object is detailed below.	On success and a Session exists.

Results Object

The results object is returned as part of the sessions object.

Field	Description	Returned
request_date	The date and time this Step was run.	On success and a Session exists and there are associated Steps.
request_type	The type of Step associated with this result. - `CUSTOM_FORM` - `PROXY_VPN` - `PHONE_VALIDATION` - `EMAIL_VALIDATION` - `DEVICE_FINGERPRINT` - `ID_VERIFICATION` An example of a `CUSTOM_FORM` object is detailed below.	On success and a Session exists and there are associated Steps.
request_id	The request ID of the result.	On success and a Session exists and there are associated Steps.
Additional Fields	All other fields are dependent on the Step associated with this result. For detailed information about each response parameter, see Response Parameters.	On success and a Session exists and there are associated Steps.

Custom Forms

The CUSTOM_FORM request type returns any information provided by the user in a "Form Page" Step.

Field	Description	Returned
success	Whether or not this Step succeeded.	Always
form_data	An object of key value pairs for the custom form data.	Always

Response Example - In Progress

{
    "message": "Success",
    "success": true,
    "workflow": "Example Flow",
    "flowRequestID": "ABCDE12345",
    "linkRequestID": "BCDEF23456",
    "sessions": [
        {
            "state": "IN_PROGRESS",
            "results": []
        }
    ]
}

Response Example - Success

{
    "message": "Success",
    "success": true,
    "workflow": "Example Flow",
    "flowRequestID": "ABCDE12345",
    "linkRequestID": "BCDEF23456",
    "sessions": [
        {
            "state": "COMPLETED",
            "results": [
                {
                    "success": true,
                    "formData": {
                        "field1": "value1",
                        "field2": "value2"
                    },
                    "request_date": "2026-01-01 12:00:00",
                    "request_type": "CUSTOM_FORM",
                    "request_id": "CDEFG34567"
                },
                {
                    "success": true,
                    # Specific fields from the proxy API
                    "request_date": "2026-01-01 12:00:00",
                    "request_type": "PROXY_VPN",
                    "request_id": "DEFGH45678"
                },
                {
                    "success": true,
                    "formData": {
                        "field3": "value1"
                    },
                    "request_date": "2026-01-01 12:00:00",
                    "request_type": "CUSTOM_FORM",
                    "request_id": "EFGHI56789"
                },
            ]
        }
    ]
}

Next Steps

Learn about the different response parameters returned by each type of Step.

Ready to eliminate fraud?

Start fighting fraud now with 1,000 Free Lookups!

We're happy to answer any questions or concerns.

Chat with our fraud detection experts any day of the week.

Call us at: (800) 713-2618

Schedule a Demo Sign Up