Create a Document Validation

POST https://api.verifik.co/v2/document-validations

A Document Validation is an instance within Verifik's system that allows you to create and manage document verification records. This endpoint creates a new document validation record with the specified configuration and settings.

Headers

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

Body

Name	Type	Description
documentType	string	The type of document being validated (e.g., "Passport", "ID", "DriverLicense").
documentNumber	string	The document number or identifier associated with the document.
url	string	URL where the document can be accessed or viewed.
type	string	The type of validation process. Can be "validation", "login", "signup", "ocr", or "demo".
redirectUrl	string	URL to redirect after the validation process is complete.
webhookUrl	string	URL for webhook callback notifications after validation.
requires2FA	boolean	Indicates if two-factor authentication is required for this validation.
namesMatch	boolean	For signup type validations, indicates if the names on the document match expected names.

Minimal Body Data

{
  "documentType": "Passport",
  "documentNumber": "123456789",
  "type": "validation"
}

Full Body Data

{
  "documentType": "Passport",
  "documentNumber": "123456789",
  "url": "https://example.com/document",
  "type": "signup",
  "redirectUrl": "https://example.com/redirect",
  "webhookUrl": "https://example.com/webhook",
  "requires2FA": false,
  "namesMatch": true
}

Request

cURL

curl -X POST https://api.verifik.co/v2/document-validations \
 -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
   "documentType": "Passport",
   "documentNumber": "123456789",
   "url": "https://example.com/document",
   "type": "signup",
   "redirectUrl": "https://example.com/redirect",
   "webhookUrl": "https://example.com/webhook",
   "requires2FA": false,
   "namesMatch": true
 }'

Node.js

const axios = require('axios');

const data = {
  documentType: "Passport",
  documentNumber: "123456789",
  url: "https://example.com/document",
  type: "signup",
  redirectUrl: "https://example.com/redirect",
  webhookUrl: "https://example.com/webhook",
  requires2FA: false,
  namesMatch: true
};

axios.post('https://api.verifik.co/v2/document-validations', data, {
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error(error.response ? error.response.data : error.message);
});

Kotlin

import android.os.AsyncTask
import java.io.OutputStream
import java.net.HttpURLConnection
import java.net.URL

fun createDocumentValidation() {
    val url = URL("https://api.verifik.co/v2/document-validations")
    val jsonBody = """
        {
          "documentType": "Passport",
          "documentNumber": "123456789",
          "url": "https://example.com/document",
          "type": "signup",
          "redirectUrl": "https://example.com/redirect",
          "webhookUrl": "https://example.com/webhook",
          "requires2FA": false,
          "namesMatch": true
        }
    """.trimIndent()
    
    AsyncTask.execute {
        with(url.openConnection() as HttpURLConnection) {
            requestMethod = "POST"
            setRequestProperty("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            setRequestProperty("Content-Type", "application/json")
            doOutput = true
            
            // Write JSON body to the request
            outputStream.use { os: OutputStream ->
                val input = jsonBody.toByteArray(Charsets.UTF_8)
                os.write(input, 0, input.size)
            }
            
            // Read the response
            val responseCode = responseCode
            if (responseCode == HttpURLConnection.HTTP_OK) {
                inputStream.bufferedReader().use {
                    val response = it.readText()
                    println("Response: $response")
                }
            } else {
                println("Request failed with code: $responseCode")
            }
        }
    }
}

Swift

import Foundation

func createDocumentValidation() {
    let url = URL(string: "https://api.verifik.co/v2/document-validations")!
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer YOUR_ACCESS_TOKEN", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    
    // JSON body
    let jsonBody: [String: Any] = [
        "documentType": "Passport",
        "documentNumber": "123456789",
        "url": "https://example.com/document",
        "type": "signup",
        "redirectUrl": "https://example.com/redirect",
        "webhookUrl": "https://example.com/webhook",
        "requires2FA": false,
        "namesMatch": true
    ]
    
    // Convert JSON to Data
    request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody, options: [])
    
    // Send request
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Request error:", error)
            return
        }
        
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print("Response data:", responseString)
        } else {
            print("Request failed with response: \(String(describing: response))")
        }
    }
    task.resume()
}

Response

The response will contain information about the new Document Validation instance. Important fields include the unique identifier _id, the status of the validation process, and the configured settings.

200

{
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "documentType": "Passport",
    "documentNumber": "123456789",
    "url": "https://example.com/document",
    "type": "signup",
    "redirectUrl": "https://example.com/redirect",
    "webhookUrl": "https://example.com/webhook",
    "requires2FA": false,
    "namesMatch": true,
    "status": "ASSESSING",
    "validationMethod": "MANUAL",
    "inputMethod": "NOT_SET",
    "imageValidated": false,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
}

422

{
  "code": "MissingParameter",
  "message": "missing documentType"
}

Key Differences from App Registration Endpoint:

• This endpoint creates a standalone document validation record

• No automatic image processing or OCR analysis

• Requires manual configuration of document details

• Used for administrative or programmatic document validation creation

• Does not automatically link to an app registration process

Note: This endpoint is different from the /document-validations/app-registration endpoint, which is specifically designed for processing documents during the app registration flow with automatic image analysis and OCR processing.