Validate Document (base64)

This endpoint allows the OCR validation process on the document sent on the request. ( Expecting images to be string base64)

To perform a document validation, the method to be used is Validate Document. The request to this method requires the sending of two photos (front & back of the document represented in string base64).

This process will perform:

• Automatic ID type recognition

• Algorithmic-based checks

• Detect security features in global identity documents

• Reading and extraction of all documents fields

In case of a validation success BiometrID will retrieve all the data extracted from the document.

Validate Document (base64)

POST Https://api.biometrid.com/api/1.1/document/validate-base64

Validate document process

Headers

Name	Type	Description
Content-type	string	Request content type (This is not required to be set. Referenced only to show how we expect data to be sent). { "Content-Type": "application/json" }
x-biometrid-key	string	Application Client Key
x-biometrid-secret	string	Application Client Secret

Request Body

Name	Type	Description
type	string	Possible values: pooling, regular. Default: regular synchronous process. See Pooling specific request.
doctype	string	Required if document type different than idcard. Possible values: idcard, passport. If not present, by default, the system will expect idcard evaluation
front	string	Image (base64 string) representation of the document's front side for biometric analysis. Max size: 1MB
back	string	Image (base64 string) representation of the document's back side for biometric analysis. Max size: 1MB
processId	string	Optional process id. Setup a specific process id.

200 Success 200 types

HTTP/1.1 200 OK

//Validate Document Process - providerA
{
    "status": true,
    "data": {
        "message": "DOCUMENT_VALIDATED_WITH_SUCCESS",
        "result": "Ok",
        "side": "0",
        "reference": "123",
        "frontCut": String base64,
        "backCut": String base64,
        "photo": String base64,
        "signature": String base64,
        "fields": {
          "normal": { ... },
          "validation": { ... }
        }
    }
}
//Validate Document Process - providerB
{
  "status": true,
  "data": {
    "message": "DOCUMENT_VALIDATED_WITH_SUCCESS",
    "result": "GOOD",
    "fields": {
      "surnames": "REIS",
      "names": "JOAO MIGUEL",
      "origin": "PRT",
      "gender": "M",
      "height": "1,89",
      "birth_date": "1900-01-01",
      "expiry_date": "2022-01-01",
      "id_number": "123456789",
      "doc_number": "123456789 5ZZZ0",
      "parents": "JOSE REIS * MARIA REIS",
      "tax_number": "123456789",
      "social_security_number": "123456789",
      "health_number": "386926259",
      "mrz": {
        "line0": "I<PRT123456<ZZY0<<<<<<<<K",
        "line1": "24123123 <<< ",
        "line2": "JOAO<<<<<<REIS>>>>"
      }
    },
    "validations": {
      "front_resolution": "GOOD [4032x3024]",
      "front_blurring": "GOOD [199.44849196759998]",
      "front_luminance": "GOOD [77]",
      "back_resolution": "GOOD [4032x3024]",
      "back_blurring": "GOOD [224.78067465369602]",
      "back_luminance": "GOOD [80]",
      "integrity_tax_number": "GOOD",
      "integrity_id_number": "GOOD",
      "integrity_doc_number": "GOOD",
      "integrity_birth_date": "GOOD",
      "integrity_expiry_date": "GOOD",
      "match_birth_date": "GOOD",
      "match_name": "FAIL",
      "match_surname": "GOOD",
      "match_gender": "GOOD",
      "match_nationality": "GOOD",
      "match_expiry_date": "GOOD",
      "expiration_date": "GOOD",
      "fake_front_value": "GOOD",
      "fake_back_value": "GOOD",
      "fake_front_ratio": 0.99,
      "fake_back_ratio": 0.99,
      "value": "GOOD"
    },
    "images": {
      "front": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA",
      "back": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIB",
      "photo": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAI"
    },
    "process": ""
  }
}
//Validate Document Process Failed
{
    "status": true,
    "data": {
        "message": "DOCUMENT_VALIDATION_FAILED",
        "result": "Warning",
        "side": "0",
        "reference": "123",
        "frontCut": String base64,
        "backCut": String base64,
        "photo": String base64,
        "signature": String base64,
        "fields": {
          "normal": { ... },
          "validation": { ... }
        }
    }
}

// Pooling request
{
  "status": true,
  "data": {
    "message": "PROCESSING",
    "process": "process identifier" // Polygon OCR processId
  }
}

//Document Not Recognised
{
    "status": false,
    "data": {
        "message": "FAILED_TO_RECOGNIZE_DOCUMENT"
    }
}

400 Bad Request types

HTTP/1.1 400 Bad Request

//No photo files detected on request. Not sent or invalid format
{
    "status": false,
    "data": {
        "message": "NO_FILE_OR_INVALID_FORMAT"
    }
}
//Missing photo files on request
{
    "status": false,
    "data": {
        "message": "EXPECTING_ALL_DOCUMENT_SIDES_TO_BE_PRESENT"
    }
}
// Missing Headers
 {
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}

// Unexpected Fields
 {
    "status": false,
    "data": {
        "message": "UNEXPECTED_FIELD"
    }
}

// Invalid front String base64 (min-validation)
 {
    "status": false,
    "data": {
        "message": "INVALID_BASE64STRING_FRONT"
    }
}

// Invalid back String base64 (min-validation)
 {
    "status": false,
    "data": {
        "message": "INVALID_BASE64STRING_BACK"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}

402 Payment Required - Request Limit Reached for Client Plan.

HTTP/1.1 402 Payment Required

{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}

404 Not Found

HTTP/1.1 404 Not Found

//Client not found by given key.
{
    "status": false,
    "data": {
        "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
    }
}

405 No active engine configuration for this provider.

HTTP/1.1 405 Method Not Allowed

{
    "status": false,
    "data": {
        "message": "NO_DOCUMENT_ENGINE_CONFIGURATION_AVAILABLE"
    }
}

504 Request timeout - algorithm unable to process the image file.

HTTP/1.1 504 Gateway Timeout

{
    "status": false,
    "data": {
        "message": "REQUEST_TIMEOUT_EXCEEDED"
    }
}

Example (JSON)

{
    "front": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA...",
    "back": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA...",
    "processId": "123"
}