Crop
This chapter was written from the product's source code and has not yet been checked by a person on a running Cogneris. If what you see on screen differs, the screen is right — please tell your Cogneris contact so the chapter can be corrected.
Crop cuts regions out of each document, such as a name or a document number. The Cogneris Vision service finds the regions: either the fields you list, or the fields it judges important.
| Palette | Nodes › Crop |
| Outputs | One output. |
| Content status | From source; not observed (workflow-fe f88c5c1, workflow-be 6703373, 2026-10-22) |
When to use it
- At the start of an identity check, so that a person can see the relevant parts of the identity document. The Identity verification template starts with Crop, followed by Facematch, Cross-check and Manual Review.
- Whenever a reviewer should check specific regions of a document rather than the whole page.
What happens in a run
The phase reads the documents from the output of the phase that leads into it, and handles them one at a time:
- A document that already failed in an earlier phase is not processed again; it is carried forward as skipped.
- The document is sent to the Vision service. When Fields to crop lists fields, the request asks the service to crop only those fields; when it is empty, the service decides what to crop.
- The crops are recorded on the document of the run.
The output is one row per document (document, crops, and skipped or error when they apply) plus the list of documents, unchanged — the next phases still work on the whole files.
The crops are kept for human review: in a Manual Review the reviewer can move, resize, add and remove crops before approving.
A process started with a Cogneris API key is sent through the Cogneris API instead of straight to the Vision service; the list of fields is passed on in the same way.
When documents fail
A failure on one document marks only that document failed; the others carry on, and later phases skip it.
- A temporary failure of the Vision service (server error, timeout, connection error, too many requests) is retried up to 3 times for that document. When the service asks to wait at most 10 seconds, the phase waits that long.
- If no document succeeded:
- and a Manual Review is still ahead in the process, the phase completes anyway and the review receives the failed documents for a person to decide;
- otherwise, if every failure was temporary, the whole phase runs again, up to 3 more times;
- otherwise the documents are marked failed and the process fails. If exactly one Send is still ahead, it runs first to deliver the failure, every other pending phase is skipped, and the process then ends as failed.
- If at least one document succeeded, a document whose temporary failure outlasted its retries is marked failed; the phase is not run again for it.
Configuration
Select the node to open Phase Configuration. Its header shows the phase type as CROPS.
| Field | What it does | Required | Format / values | Default | Validation messages |
|---|---|---|---|---|---|
| Description | The name shown on the node. | No | Free text. Left empty, the node keeps its previous name. | Crop | — |
| Fields to crop | The fields the Vision service should crop. The hint reads Comma-separated list. Leave empty to let the AI auto-detect important fields. | No | Field names separated by commas, for example the placeholder Name, CPF, RG. Spaces around each name are removed and empty entries are dropped. The names are passed to the AI as written; they are not checked against a template. | Empty — the AI detects the fields | — |
Common problems
| Message | Cause | What to do |
|---|---|---|
| Auth token missing for run; cannot call the document service. (service text, run error) | The process carries no credential for the Vision service. | Start the process again. If it persists, contact Cogneris support. |
| No documents found for crops. (service text, run error) | The phase received no documents. | Check that the phase leading into Crop passes documents on, for example that it is linked from Start. |
| crops: no document succeeded — … (service text, run error) | Every document failed. The text lists the error of each one. | Read each document's error, check the files, then start the process again. |
| crops: no document succeeded because all failures were transient — … (service text) | Every document hit a temporary failure. The phase is run again automatically. | Wait. If the process then fails, start it again later. |
Related
- Facematch, Cross-check — the rest of an identity check
- Manual Review and Organize human review
- Design and publish a workflow
Last reviewed 2026-10-22 · Version 1.0.0 · Owner: product-documentation