Accept cropped images

A fully cropped image is one that shows only the document, with no surrounding background. Cropping is treated as a form of digital tampering, because a live document presented in a live situation always has physical context around it.

Therefore, by default, Verify will not pass a cropped document unless you explicitly allow it in the configuration.

tip

If you use the Verify SDK, this situation doesn't arise. The SDK only allows images captured in live conditions and does not permit fully cropped images to be submitted.

Accept cropped images

Cropping is governed by a single boolean setting, verification.settings.cropAffectsVerdict, which defaults to true.

With the default, a cropped document cannot be accepted (cannot receive "Accept" in its verdict). The only verdicts available to it are a rejection or a referral to manual review.

Set cropAffectsVerdict to false when you control the cropping yourself, for example because a client-side SDK does it. Cropped images are then fully processed and can be accepted.

configuration.json

{
  "verification": {
    "settings": { "cropAffectsVerdict": false }
  }
}

The configuration travels as a single JSON configuration part alongside the images:

cURL

curl https://us-east.verify.microblink.com/api/v3/verify \
  --request POST \
  --header 'Authorization: Basic <credentials>' \
  --form 'imageFirstSide=@front_id.jpg' \
  --form 'imageSecondSide=@back_id.png' \
  --form 'configuration=@configuration.json;type=application/json' \
  --form 'consent={
  "userId": "<your-id-for-the-end-user>",
  "durationDays": 365
}'

JavaScript

const formData = new FormData()
formData.append('imageFirstSide', new Blob([]), 'front_id.jpg')
formData.append('imageSecondSide', new Blob([]), 'back_id.png')
formData.append('configuration', new Blob([]), 'configuration.json')
formData.append('consent', '{
  "userId": "<your-id-for-the-end-user>",
  "durationDays": 365
}')

fetch('https://us-east.verify.microblink.com/api/v3/verify', {
  method: 'POST',
  headers: {
    Authorization: 'Basic <credentials>'
  },
  body: formData
})

Python

requests.post(
    "https://us-east.verify.microblink.com/api/v3/verify",
    headers={
      "Authorization": "Basic <credentials>"
    },
    files=[
      ("imageFirstSide", open("front_id.jpg", "rb")),
      ("imageSecondSide", open("back_id.png", "rb")),
      ("configuration", ("configuration.json", open("configuration.json", "rb"), "application/json"))
    ],
    data={
      "consent": "{\n  \"userId\": \"<your-id-for-the-end-user>\",\n  \"durationDays\": 365\n}"
    }
)

Go

package main

import (
	"bytes"
	"fmt"
	"io"
	"mime/multipart"
	"net/http"
	"os"
)

func main() {
	requestUrl := "https://us-east.verify.microblink.com/api/v3/verify"

	payload := &bytes.Buffer{}
	writer := multipart.NewWriter(payload)

	part, _ := writer.CreateFormFile("imageFirstSide", "front_id.jpg")

	f, _ := os.Open("front_id.jpg")
	defer f.Close()

	_, _ = io.Copy(part, f)

	part, _ = writer.CreateFormFile("imageSecondSide", "back_id.png")

	f, _ = os.Open("back_id.png")
	defer f.Close()

	_, _ = io.Copy(part, f)

	part, _ = writer.CreateFormFile("configuration", "configuration.json")

	f, _ = os.Open("configuration.json")
	defer f.Close()

	_, _ = io.Copy(part, f)

	_ = writer.WriteField("consent", "{\n  \"userId\": \"<your-id-for-the-end-user>\",\n  \"durationDays\": 365\n}")
	writer.Close()

	req, _ := http.NewRequest("POST", requestUrl, payload)

	req.Header.Set("Content-Type", writer.FormDataContentType())
	req.Header.Add("Authorization", "Basic <credentials>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Reading the result

Cropping detection is reported in imageAssessment, independently of the setting. Turning cropAffectsVerdict off changes what the verdict does with the detection, not whether the detection runs.

{
  "imageAssessment": {
    "croppedDocumentCheck": {
      "result": "Fail",
      "firstSide": { "result": "Fail" },
      "secondSide": { "result": "Pass" }
    }
  }
}

A Fail here means the side was found to be cropped. With cropAffectsVerdict set to false, that finding is informational: verification.verdict can still be Accept.