Table of contents

IdentityProcessor

The IdentityProcessor class provides utility APIs for processing identity documents.

Name Description
static findPortraitZone() Finds the precise location of the portrait zone on an identity document.

findPortraitZone

Finds the precise location of the portrait zone on an identity document.

static findPortraitZone(cvRouter: CaptureVisionRouter): Promise<Quadrilateral | null>;

Parameters

cvRouter: A CaptureVisionRouter instance used to perform the detection.

Return Value

A promise that resolves with a Quadrilateral object defining the precise location of the portrait zone found in the image, or null if no portrait zone is detected.

See also

Code snippet

let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
const quad = await Dynamsoft.IdentityUtility.IdentityProcessor.findPortraitZone(router);
if (quad) {
    console.log("Portrait zone found:", quad);
} else {
    console.log("No portrait zone detected.");
}

Remarks

Added in CaptureVisionBundle version 3.4.2000. Starting from version 3.6.2000, a CaptureVisionRouter instance is required as a parameter.

This page is compatible for: