Identity: Get Details

GET

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

Retrieves the complete identity verification details for a specific verification instance within a flow.

This includes all extracted document data (e.g., name, date of birth, document number), associated files (like front and back images), verification steps (such as IP validation or biometric checks), error logs (e.g., expired document, country mismatch), and overall status (e.g., approved, rejected).

Use this endpoint to programmatically review all the identity-related data captured during the verification process and understand why a verification was approved or rejected.

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/identities/' \
--header 'Accept;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
  "_id": "67ead05f66d86f9778eaa148",
  "flow": "67cf079a0ebe7c5442de4a23",
  "user": "64204dd759290a9403fef44e",
  "flow_instance": "67eab94e66d86f9778eaa0d7",
  "flow_event": "67ead05f66d86f9778eaa142",
  "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,
              "label": "Document Side"
            },
            "document": {
              "value": null,
              "required": false,
              "label": "Document"
            },
            "endorsement": {
              "value": null,
              "required": false,
              "label": "Endorsement"
            },
            "expiryDay": {
              "value": "2",
              "required": false,
              "label": "Day of Expiry",
              "format": "date"
            },
            "expiryMonth": {
              "value": "1",
              "required": false,
              "label": "Month of Expiry",
              "format": "date"
            },
            "expiryYear": {
              "value": "2025",
              "required": false,
              "label": "Year of Expiry",
              "format": "date"
            },
            "eyeColor": {
              "value": null,
              "required": false,
              "label": "Eye Color"
            },
            "firstNameLocal": {
              "value": null,
              "required": false,
              "label": "First Name Local"
            },
            "fullNameLocal": {
              "value": null,
              "required": false,
              "label": "Full Name Local"
            },
            "hairColor": {
              "value": null,
              "required": false,
              "label": "Hair Color"
            },
            "height": {
              "value": null,
              "required": false,
              "label": "Height"
            },
            "issueAuthority": {
              "value": null,
              "required": false,
              "label": "Issue Authority"
            },
            "issueDay": {
              "value": null,
              "required": false,
              "label": "Day of Issue",
              "format": "date"
            },
            "issueMonth": {
              "value": null,
              "required": false,
              "label": "Month of Issue",
              "format": "date"
            },
            "issueYear": {
              "value": null,
              "required": false,
              "label": "Year of Issue",
              "format": "date"
            },
            "internalId": {
              "value": "487",
              "required": false,
              "label": "Internal ID"
            },
            "countryIso3": {
              "value": "CHL",
              "required": false,
              "label": "Country ISO 3"
            },
            "countryIso2": {
              "value": "CL",
              "required": false,
              "label": "Country ISO 2"
            },
            "countryFull": {
              "value": "Chile",
              "required": false,
              "label": "Country Full"
            },
            "stateFull": {
              "value": null,
              "required": false,
              "label": "State Full"
            },
            "lastNameLocal": {
              "value": null,
              "required": false,
              "label": "Last Name Local"
            },
            "middleName": {
              "value": null,
              "required": false,
              "label": "Middle Name"
            },
            "middleNameLocal": {
              "value": null,
              "required": false,
              "label": "Middle Name Local"
            },
            "nationalityIso3": {
              "value": "CHL",
              "required": false,
              "label": "Nationality ISO 3"
            },
            "nationalityIso2": {
              "value": "CL",
              "required": false,
              "label": "Nationality ISO 2"
            },
            "nationalityFull": {
              "value": "Chile",
              "required": false,
              "label": "Nationality Full"
            },
            "optionalData": {
              "value": "A17",
              "required": false,
              "label": "Optional Data"
            },
            "optionalData2": {
              "value": "26076079 3",
              "required": false,
              "label": "Optional Data 2"
            },
            "optionalData3": {
              "value": null,
              "required": false,
              "label": "Optional Data 3"
            },
            "optionalData4": {
              "value": null,
              "required": false,
              "label": "Optional Data 4"
            },
            "placeOfBirth": {
              "value": "VEN",
              "required": false,
              "label": "Place of Birth"
            },
            "postcode": {
              "value": null,
              "required": false,
              "label": "Postcode"
            },
            "restrictions": {
              "value": null,
              "required": false,
              "label": "Restrictions"
            },
            "vehicleClass": {
              "value": null,
              "required": false,
              "label": "Vehicle Class"
            },
            "weight": {
              "value": null,
              "required": false,
              "label": "Weight"
            },
            "daysToExpiry": {
              "value": "-88",
              "required": false,
              "label": "Days to Expiry"
            },
            "daysFromIssue": {
              "value": "1895",
              "required": false,
              "label": "Days from Issue"
            },
            "age": {
              "value": "45",
              "required": false,
              "label": "Age"
            },
            "signature": {
              "value": null,
              "required": false,
              "label": "Signature"
            },
            "bardcode": {
              "value": null,
              "required": false,
              "label": "Barcode"
            },
            "face": {
              "value": null,
              "required": false,
              "label": "Face"
            },
            "visaType": {
              "value": null,
              "required": false,
              "label": "Visa Type"
            },
            "entityType": {
              "value": null,
              "required": false,
              "label": "Entity Type"
            },
            "businessName": {
              "value": null,
              "required": false,
              "label": "Business Name"
            },
            "businessNameLocal": {
              "value": null,
              "required": false,
              "label": "Business Name Local"
            },
            "businessRegistrationNumber": {
              "value": null,
              "required": false,
              "label": "Business Registration Number"
            },
            "mrz": {
              "value": "IECHL6022948360A17<<<<<<<<<<<<7908219M2501028VEN26076079<3<8MERA<LOPEZ<<MARCOS<ENRIQUE<<<<",
              "required": false,
              "label": "MRZ"
            },
            "reverseId": {
              "value": "488",
              "required": false,
              "label": "Reverse ID"
            },
            "backSideId": {
              "value": "488",
              "required": false,
              "label": "Back Side ID"
            },
            "id": {
              "value": null,
              "required": false,
              "label": "ID"
            },
            "profileId": {
              "value": null,
              "required": false,
              "label": "Profile ID"
            },
            "reviewScore": {
              "value": null,
              "required": false,
              "label": "Review Score"
            },
            "rejectScore": {
              "value": null,
              "required": false,
              "label": "Reject Score"
            },
            "decision": {
              "value": null,
              "required": false,
              "label": "Decision"
            },
            "docupass": {
              "value": null,
              "required": false,
              "label": "Docupass"
            },
            "customData": {
              "value": null,
              "required": false,
              "label": "Custom Data"
            },
            "createdAt": {
              "value": null,
              "required": false,
              "label": "Created At",
              "format": "date"
            },
            "updatedAt": {
              "value": null,
              "required": false,
              "label": "Updated At",
              "format": "date"
            }
          }
        }
      ]
    }
  ],
  "steps": [
    {
      "id": "ip-validation",
      "error": null,
      "status": 200,
      "data": {
        "country": "Brasil",
        "countryCode": "BR"
      }
    }
  ],
  "mati_id": null,
  "is_migrated": false,
  "data": {
    "country": "CHL",
    "document_type": "NATIONAL_ID",
    "file_key_document": "document_key_123",
    "file_key_document_back": "document_back_key_123",
    "config_service": {
      "age_threshold": 18
    }
  },
  "status": "APPROVED",
  "file_references_data": [
    {
      "id": "e46f59b1-a45c-45bd-a408-204da7de23f0",
      "field_name": "document_key_123",
      "original_name": "Documento Frontal.jpg",
      "encoding": "7bit",
      "mime_type": "image/jpeg",
      "size": 453546,
      "path": "source-documents-of-rillis/67eab94e66d86f9778eaa0d7/",
      "file_name": "e46f59b1-a45c-45bd-a408-204da7de23f0.jpeg",
      "service_code": "ONBOARDING_FORM_COMPANY_SERVICE"
    },
    {
      "id": "53371e17-6213-49e0-b967-52d81f748b68",
      "field_name": "document_back_key_123",
      "original_name": "Documento Trasero.jpg",
      "encoding": "7bit",
      "mime_type": "image/jpeg",
      "size": 521575,
      "path": "source-documents-of-rillis/67eab94e66d86f9778eaa0d7/",
      "file_name": "53371e17-6213-49e0-b967-52d81f748b68.jpeg",
      "service_code": "ONBOARDING_FORM_COMPANY_SERVICE"
    }
  ],
  "completed_at": "2025-03-31T17:27:12.465Z",
  "created_at": null,
  "updated_at": null,
  "reason": null,
  "photos": [
    "http://api2-us3.idanalyzer.com/image/fee1c4ecc60740f895fe8c2af7581373/a4239c3ac3f3ca2cc051ab270eb32cd0af0c98aa7f1a6c944234015e17619862/front.jpg",
    "http://api2-us3.idanalyzer.com/image/fee1c4ecc60740f895fe8c2af7581373/a4239c3ac3f3ca2cc051ab270eb32cd0af0c98aa7f1a6c944234015e17619862/back.jpg",
    "http://api2-us3.idanalyzer.com/image/fee1c4ecc60740f895fe8c2af7581373/a4239c3ac3f3ca2cc051ab270eb32cd0af0c98aa7f1a6c944234015e17619862/face.jpg"
  ],
  "createdAt": "2025-03-31T17:26:55.167Z",
  "updatedAt": "2025-03-31T17:27:12.466Z",
  "computed": {
    "age": {
      "data": "45"
    },
    "isDocumentExpired": {
      "data": {
        "Documento de Identidad": true
      }
    }
  },
  "errors": [
    {
      "code": "IP_COUNTRY_MISMATCH",
      "description": "Inconsistency between user IP address country (BR) and document country (CL).",
      "severity": "low",
      "confidence": 1,
      "decision": "accept"
    },
    {
      "code": "DOCUMENT_EXPIRED",
      "description": "Document has already expired.",
      "severity": "high",
      "confidence": 0.998,
      "decision": "reject"
    }
  ]
}

Modified at 2025-05-29 15:11:45

Get File from Flow Instance

Identity: Get Files