Skip to main content

Recuperar una Validación de Documento

Endpoint​

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

Con este servicio puedes obtener todas las Validaciones de Documentos que has creado o, si solo deseas una, especifica el ID de la validación y el endpoint devolverá únicamente la validación seleccionada.

Encabezados​

Content-Type​

Tipo: String
Requerido: Sí

application/json

Authorization​

Tipo: String
Requerido: Sí

Bearer <token>

Parámetros de Ruta​

id​

Tipo: string
Requerido: Sí

ID de la Validación de Documento cuya información deseas obtener.

Parámetros de Consulta​

populates[]​

Tipo: string
Requerido: No

Opciones: appRegistration, projectFlow

Solicitud​

import axios from "axios";

const options = {
    method: "GET",
    url: "https://api.verifik.co/v2/document-validations/document_validation_123456789",
    params: {
        "populates[]": ["appRegistration", "projectFlow"],
    },
    headers: {
        "Content-Type": "application/json",
        Authorization: "Bearer <your_token>",
    },
};

try {
    const { data } = await axios.request(options);
    console.log(data);
} catch (error) {
    console.error(error);
}

Respuesta​

{
  "data": {
    "_id": "document_validation_123456789",
    "age": "25",
    "appRegistration": {
      "_id": "reg_123456789",
      "email": "user@example.com",
      "status": "completed"
    },
    "backUrl": "https://example.com/back",
    "client": "client_123456789",
    "country": "US",
    "createdAt": "2024-01-15T10:30:00Z",
    "documentData": {
      "firstName": "John",
      "lastName": "Doe",
      "documentNumber": "123456789",
      "birthDate": "1999-01-15"
    },
    "documentType": "id",
    "frontUrl": "https://example.com/front",
    "images": {
      "frontImage": "base64_encoded_image",
      "backImage": "base64_encoded_image"
    },
```json
      "_id": "flow_123456789",
      "name": "Example Flow",
      "type": "onboarding"
    },
    "status": "completed",
    "updatedAt": "2024-01-15T10:32:00Z",
    "validationResults": {
      "documentAuthenticity": "passed",

### Características
  }
- **Recuperación por ID**: Obtén una validación de documento específica usando su ID único
- **Información completa**: Incluye todos los detalles del proceso de validación
- **Datos del documento**: Información extraída del documento (nombre, número, fecha de nacimiento)
- **Resultados OCR**: Confianza y texto extraído del reconocimiento óptico de caracteres
- **Imágenes**: Imágenes del documento (frente y reverso) en base64
- **Datos relacionados**: Información del registro de aplicación y flujo del proyecto
- **Resultados de validación**: Autenticidad del documento y consistencia de datos
- **Múltiples lenguajes**: Soporte para JavaScript, Python, PHP y Go
- **Manejo de errores**: Respuestas de error detalladas para distintos escenarios
</TabItem>
<TabItem value="404" label="404">

```json
{
  "error": "Document validation not found",
  "message": "DOCUMENT_VALIDATION_NOT_FOUND"
}

  </TabItem>
</Tabs>

### Features

-   **Retrieval by ID**: Get a specific document validation using its unique ID
-   **Complete Information**: Includes all document validation process details
-   **Document Data**: Information extracted from the document (name, number, birth date)
-   **OCR Results**: Confidence and extracted text from optical character recognition
-   **Images**: Front and back document images in base64
-   **Related Data**: Application registration and project flow information
-   **Validation Results**: Document authenticity and data consistency
-   **Multiple Languages**: Support for JavaScript, Python, PHP, and Swift
-   **Error Handling**: Detailed error responses for different scenarios