Pooling

This endpoint allows fetching the results from a previous document validation process, that was initiated with the pooling option.

This method is only necessary if you want to implement asynchronous calls to the OCR engine. This method can be called multiple times after the previous necessary Validate Document process is started with the corresponding pooling option. It will return the verification result when the engine finishes the validation process.

Document - Pooling

POST https://api.biometrid.com/api/1.1/document/pooling

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": "multipart/form-data" }
x-biometrid-key	string	Application Client Key
x-biometrid-secret	string	Application Client Secret

Request Body

Name	Type	Description
process	string	Polygon OCR process returned from document validate request (if pooling type option sent).
processId	string	Client own process reference.

200 Success 200 types

HTTP/1.1 200 OK

// Response when process still validating
{
	"status": true,
	"data": {
		"message": "PROCESSING",
		"process": "process identifier" // Polygon OCR processId
	}
}

//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": "5ed91c890482a7306bbc2511"
  }
}

400 Bad Request types

HTTP/1.1 400 Bad Request

// Process missing on request
{
    "status": false,
    "data": {
        "message": "PROCESS_MISSING"
    }
}

// Process sent not found
{
    "status": false,
    "data": {
        "message": "POOLING_PROCESS_NOT_FOUND"
    }
}

// Invalid account id
{
    "status": false,
    "data": {
        "message": "INVALID_OCR_ACCOUNT_ID"
    }
}

// OCR process failed
{
    "status": false,
    "data": {
        "message": "OCR_PROCESS_FAILED"
    }
}

// Document not detected on previous files sent
{
    "status": false,
    "data": {
        "message": "DOCUMENT_NOT_DETECTED"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

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

404 Client not found by given key.

HTTP/1.1 404 Not Found

{
    "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"
    }
}

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

Example (JSON)

{
	"process": "5ed91c890482a7306bbc2511", // Polygon OCR processId
	"processId": "some reference", // Client own process reference
}