Retrieve a Document Validation

GET https://api.verifik.co/v2/document-validations/{id}

With this service, you can bring all Document Validations that you have created or if you only want one, you can specify the ID of the document validation and the endpoint will return only the selected validation.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Query Parameters

Name	Type	Description
id	string	ID of the Document Validation that you want to bring the information.
populates[]	string	Options: appRegistration, projectFlow

Response

200

{
    "data": {
        "_id": "507f1f77bcf86cd799439011",
        "age": "25",
        "appRegistration": "507f1f77bcf86cd799439012",
        "backUrl": "https://example.com/back",
        "client": "507f1f77bcf86cd799439013",
        "country": "United States",
        "customDocumentType": "Enhanced Driver License",
        "documentCategory": "Government ID",
        "documentNumber": "DL123456789",
        "documentType": "driver_license",
        "firstNameMatchPercentage": 95.5,
        "fullNameMatchPercentage": 92.0,
        "gender": "Female",
        "imageValidated": true,
        "infoValidationSupported": true,
        "infoValidationSupportedReason": "Document type supported",
        "inputMethod": "CAMERA",
        "lastNameMatchPercentage": 88.5,
        "namesMatch": true,
        "nationality": "US",
        "OCRExtraction": {
            "extractedText": "Sample extracted text",
            "confidence": 0.95
        },
        "project": "507f1f77bcf86cd799439014",
        "projectFlow": "507f1f77bcf86cd799439015",
        "redirectUrl": "https://example.com/success",
        "requiresBackSide": true,
        "scoreValidated": true,
        "scoreValidation": {
            "overallScore": 0.92,
            "threshold": 0.85
        },
        "status": "ACTIVE",
        "template": "507f1f77bcf86cd799439016",
        "type": "validation",
        "url": "https://example.com/document/image",
        "validationMethod": "OCR",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
    }
}

404

{
  "code": "NotFound",
  "message": "DocumentValidation_not_found"
}

Status Code	Description
404	DocumentValidation not found