Get Flow Instance

GET

https://aws-verification-id-dev.rillis.io/api/v1/client-api/flow-instance/{id}

Fetch results of a flow instance, which is the complete record of user-provided answers 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 ********************

Path Params

Header Params

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://aws-verification-id-dev.rillis.io/api/v1/client-api/flow-instance/' \
--header 'Accept;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
  "_id": "67eab94e66d86f9778eaa0d7",
  "flow": "67cf079a0ebe7c5442de4a23",
  "user": "64204dd759290a9403fef44e",
  "inputs_data": {
    "VERIFICATION_IDENTITY_SERVICE": {
      "config_service": {
        "age_threshold": 18
      },
      "country": "CHL",
      "document_type": "NATIONAL_ID",
      "file_key_document": "verifi_document",
      "file_key_document_back": "verifi_document_back",
      "identityRef": {
        "id": "67ead05e66d86f9778eaa12a",
        "model": "Identity",
        "data": {
          "_id": "67ead05e66d86f9778eaa12a",
          "flow": "67cf079a0ebe7c5442de4a23",
          "user": "64204dd759290a9403fef44e",
          "flow_instance": "67eab94e66d86f9778eaa0d7",
          "flow_event": "67ead05e66d86f9778eaa128",
          "documents": [
            {
              "type": "Documento de Identidad",
              "steps": [
                {
                  "status": 200,
                  "cacheHit": false,
                  "reused": false,
                  "id": "document-reading",
                  "error": null,
                  "data": {
                    "fullName": {
                      "value": "MARCOS ENRIQUE MERA LOPEZ",
                      "required": true,
                      "label": "Name"
                    },
                    "emissionDate": {
                      "value": "2020-01-22",
                      "required": false,
                      "label": "Emission Date",
                      "format": "date"
                    },
                    "documentNumber": {
                      "value": "602.294.836",
                      "required": true,
                      "label": "Document Number"
                    },
                    "personalNumber": {
                      "value": "26.076.079-3",
                      "required": false,
                      "label": "Personal Number"
                    },
                    "dateOfBirth": {
                      "value": "1979-08-21",
                      "required": true,
                      "label": "Day of Birth",
                      "format": "date"
                    },
                    "expirationDate": {
                      "value": "2025-01-02",
                      "required": false,
                      "label": "Date of Expiration",
                      "format": "date"
                    },
                    "documentType": {
                      "value": "Documento de Identidad",
                      "required": false,
                      "label": "Document Type"
                    },
                    "firstName": {
                      "value": "MARCOS ENRIQUE",
                      "required": false,
                      "label": "First Name"
                    },
                    "lastName": {
                      "value": "MERA LOPEZ",
                      "required": false,
                      "label": "Last Name"
                    },
                    "surname": {
                      "value": "MERA LOPEZ",
                      "required": false,
                      "label": "Surname"
                    },
                    "issueCountry": {
                      "value": "Chile",
                      "required": false,
                      "label": "Issue Country"
                    },
                    "sex": {
                      "value": "M",
                      "required": false,
                      "label": "Sex"
                    },
                    "address2": {
                      "value": null,
                      "required": false,
                      "label": "Address 2"
                    },
                    "dobDay": {
                      "value": "21",
                      "required": false,
                      "label": "Day of Birth",
                      "format": "date"
                    },
                    "dobMonth": {
                      "value": "8",
                      "required": false,
                      "label": "Month of Birth",
                      "format": "date"
                    },
                    "dobYear": {
                      "value": "1979",
                      "required": false,
                      "label": "Year of Birth",
                      "format": "date"
                    },
                    "documentName": {
                      "value": "Identity Card",
                      "required": false,
                      "label": "Document Name"
                    },
                    "documentNumber2": {
                      "value": null,
                      "required": false,
                      "label": "Document Number 2"
                    },
                    "documentSide": {
                      "value": "FRONT",
                      "required": false,

Modified at 2025-05-29 16:42:54

Authentication token

Get File from Flow Instance