Get Flow Instances

GET

https://verification-id.rillis.io/api/v1/client-api/flow-instance

It retrieves paginated results from a list of flow instances, which is the complete record of user-provided responses and all associated data within the system.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://verification-id.rillis.io/api/v1/client-api/flow-instance?limit=10&status=PENDING&period=day&flow=689f9ea066a93b49bd44ac13&service=VERIFICATION_IDENTITY_SERVICE&metadata={"is_fullpage": "true"}&skip=0&search=query string&from=1771274043&to=1771274043' \
--header 'Accept;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "items": [
        {
            "_id": "69151dbe4ba70a5299e7c11b",
            "flow": {
                "_id": "689f9ea066a93b49bd44ac13",
                "name": "verificacion + onb person",
                "description": "descripcion ejemplo",
                "is_active": true
            },
            "user": {
                "_id": "64204dd759290a9403fef44e",
                "company_name": "Andean Wide",
                "email": "client@gmail.com",
                "client_id": "NCK4Z5H4Xs3rr/iS0KfV7R5yr/Z81bEp2KJvlW62E5E="
            },
            "inputs_data": {
                "VERIFICATION_IDENTITY_SERVICE": {
                    "config_service": {
                        "age_threshold": 18
                    },
                    "country": "ALB"
                }
            },
            "file_references_data": [],
            "events_generated": [
                "VERIFICATION_IDENTITY",
                "ONBOARDING_FORM_INDIVIDUAL"
            ],
            "events_batches": [
                [
                    "VERIFICATION_IDENTITY",
                    "ONBOARDING_FORM_INDIVIDUAL"
                ]
            ],
            "status": "PENDING",
            "metadata": {
                "name": "john doe",
                "url_path": "/",
                "is_fullpage": "true"
            },
            "completed_at": null,
            "session_id": "379107e6-9e6d-4854-ac25-3b06f40deefe",
            "createdAt": "2025-11-12T23:52:30.093Z",
            "updatedAt": "2025-11-12T23:52:35.737Z",
            "metadata_frontend": {
                "service_step": "0",
                "flow_step": "0"
            },
            "widget_url": "https://aws-dev.rillis.io/identity?session_id=379107e6-9e6d-4854-ac25-3b06f40deefe&client_id=NCK4Z5H4Xs3rr/iS0KfV7R5yr/Z81bEp2KJvlW62E5E=&flow=689f9ea066a93b49bd44ac13"
        }
    ],
    "totalItems": 72,
    "page": 2,
    "totalPages": 8
}

Modified at 2026-02-16 20:37:57

Authentication token

Get Flow Instance By Id