Delete a document validation

Endpoint

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

This endpoint deletes a specific Document Validation record in Verifik. Upon successful deletion, it returns the details of the deleted document validation along with the deletion status.

Headers

Include the necessary authentication headers for authorization and content-type, such as:

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

Request Parameters

• Path Parameter:

  • id (string, required): The unique identifier of the Document Validation to delete.

Request

cURL

curl --location --request DELETE 'https://api.verifik.co/v2/document-validations/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Node.js

const axios = require('axios');

const config = {
  method: 'delete',
  url: 'https://api.verifik.co/v2/document-validations/{id}',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
};

axios(config)
  .then(response => {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(error => {
    console.error(error);
  });

Responses

On a successful request, you will receive a JSON object with the details of the deleted Document Validation, including the document's metadata, validation status, and OCR extraction details.

Success Response (200)

200

{
  "data": {
    "_id": "62a0ff1880ba4745a1a94fa1",
    "documentNumber": "123456789",
    "documentType": "DLXX",
    "project": "62ae085c963a3247fda57c4",
    "projectFlow": "62ae0b3c963a3247fda57cb",
    "url": "https://cdn.verifik.co/ocr/samples/sample-image.jpg",
    "status": "ACTIVE_BUT_UNVERIFIED",
    "imageValidated": true,
    "validationMethod": "SCAN_PROMPT",
    "inputMethod": "NOT_SET",
    "namesMatch": true,
    "fullNameMatchPercentage": 100,
    "firstNameMatchPercentage": 100,
    "lastNameMatchPercentage": 100,
    "OCRExtraction": {
      "dateOfBirth": "20-JAN-1990",
      "placeOfBirth": "SAO PAULO",
      "height": "1.72",
      "bloodType": "A+",
      "gender": "Female",
      "age": "Unknown",
      "expeditionDate": "10-FEB-2010",
      "expeditionPlace": "SAO PAULO",
      "barcodeNumber": "A-1234567-8901234-F-1234567890-20230101",
      "country": "Brazil",
      "documentType": "DLXX",
      "firstName": "MARIA CARLA",
      "lastName": "SILVA SANTOS",
      "fullName": "MARIA CARLA SILVA SANTOS",
      "documentNumber": "123456789"
    },
    "scoreValidated": true,
    "type": "signup",
    "appRegistration": "62b03bdfb541ca63ff7241f3",
    "client": "62a7f594e3bb7129d1d89af",
    "updatedAt": "2024-10-29T15:29:37.853Z",
    "createdAt": "2024-10-29T15:28:24.313Z",
    "__v": 0,
    "documentCategory": "DriverLicense",
    "requiresBackSide": false,
    "scoreValidation": {
      "arrayName": [
        "MARIA",
        "CARLA",
        "SILVA",
        "SANTOS"
      ],
      "dateOfBirth": "20-JAN-1990",
      "documentNumber": "123456789",
      "documentType": "DLXX",
      "expeditionDate": "10-FEB-2010",
      "expeditionPlace": "SAO PAULO",
      "firstName": "MARIA CARLA",
      "fullName": "MARIA CARLA SILVA SANTOS",
      "lastName": "SILVA SANTOS",
      "validatedAt": "2024-10-29 15:29:37"
    }
  },
  "status": "completed"
}

404

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

Error Responses

Status Code	Description
404	DocumentValidation not found