Verify
Verify
Breadcrumbs

Graphics Inspection

Graphics Inspection

📌 API Reference: https://verify-api-docs.globalvision.co/reference/creategraphicsjob

This feature automatically compares two image files to detect visual differences, ensuring artwork or packaging designs remain consistent and error-free.

Inspection Features (API Input)

You can leverage any of the features below to prepare your inspection:

Feature

API Parameter Example

Document ID (required)

  • For both Master and Sample objects

  • Leverage this parameter to inform the ID of the file you want to inspect.

 
{
  "documentId": "your_doc_ID"
}

Graphics Custom Profile Sensitivity

  • Defaults to: Low

  • Determines how sensitive the algorithm should be to decide if there is a difference. It accepts a string or a unique ID (UUID) for a custom profile.

 
{
      "profile": {
        "sensitivity": "Low"
      }

Review In Verify

  • Use this option if you’d like to generate a Verify User Interface URL to review the inspection results in our user interface.

  • Options are: True and False.

  • Defaults to false.

 
"reviewInVerify": true,

Auto-Prep Layers

  • For both Master and Sample objects

  • When active, this configuration will go through the layers of the file and use an AI-based logic to automatically hide selected layers that obstruct the content to be inspected.

  • Options are: True and False.

  • Defaults to false.

 
"autoPrepLayers": true,

Auto-Prep Separations

  • For both Master and Sample objects

  • When active, this configuration will go through the separations/inks of the file and use an AI-based logic to automatically hide selected separations that obstruct the content to be inspected.

  • Options are: True and False.

  • Defaults to false.

 
"autoPrepSeparations": true,

Layers Visibility

  • For both Master and Sample objects

  • By default, all layers are visible.

  • Configures which layers in a document are visible during the inspection process. This is especially relevant for files that contain multiple or complex layers, such as PDF or design files.

 
"layersVisibility": [
        {
          "name": "layer1",
          "visible": false
        },
        {
          "name": "layer2",
          "visible": false
        }
      ]

Separations to Hide

  • For both Master and Sample objects

  • Lists the names of separations (inks) to hide during inspection. Use this to exclude specific color channels from the inspection process.

  • This is useful for focusing on certain inks (e.g., black) or removing distracting elements from the inspection.

 
      "separationsToHide": [
        "separation1",
        "separation2"
      ]

Shape to Selected Layer

  • For both Master and Sample objects

  • Defines an object for cropping the inspection region based on a selected layer's shape.

  • All visible layers within this area will be included in the inspection, allowing you to focus the analysis on specific zones of interest.

 
"shapeTo": {
    "selectedLayerName": "layer1"
      }

Shape to Selected Separation

  • For both Master and Sample objects

  • Specifies the name of a separation (ink) whose shape is used to crop the inspection region.

  • All visible content within the area covered by this separation will be inspected.

 
"shapeTo": {
    "selectedSeparationName": "separation1"
      }

PDF Box Type

  • For both Master and Sample objects

  • Sets the PDF box used to crop the document for inspection.

  • Options are: CropBox, MediaBox, BleedBox, TrimBox, and ArtBox.

  • Choosing the appropriate box helps focus the inspection on the desired content area and can improve accuracy by excluding irrelevant margins or marks.

 
"pdfBoxType": "CropBox"

Report Type

  • Determines the format and content of the PDF inspection report.

  • Options:

    • default: will generate a report with a summary, thumbnails, and an annotated report using the sample document.

    • summaryAnnotated: will generate a report with a summary and an annotated report using the sample document.

    • detailed: will generate a report with only the thumbnails.

    • detailedAnnotated: will generate a report with the thumbnails and an annotated report using the sample document.

    • annotated: will generate a report with only the annotated report using the sample document.

  • Defaults to default

 
"reportType": "detailedAnnotated"

Annotated Report Source

  • Defaults to: Sample

  • Source of the annotated report, valid options are master or sample.

  • Will be used only if reportType is summaryAnnotated.

 
{
      "annotatedReportSource": "sample",
      "reportType": "default"
    }


Inspection Results (API Output)

The official output of this API endpoint will be the Job ID. Use this ID to access all the inspection details described below.

Inspection Result

API Output Example

Report URL

  • Link to the generated PDF inspection report.

  • The content of this report is determined by the reportType parameter.

 
"reportUrl": "https://verify-automation-api.globalvision.co/files/automation-report?fileKey=PDF_File_Key"

XFDF Reports

  • Links to XFDF annotation files for both master and sample documents (if available), which can be used for further integration with PDF viewers or automated review systems.

 
"xfdfReports": {
                "master": https://verify-automation-api.globalvision.co/files/automation-report?fileKey=XFDF_File_key,
                "sample": "https://verify-automation-api.globalvision.co/files/automation-report?fileKey=XFDF_File_key"
                {

Verify URL

  • URL that can be accessed to review the results in the Verify User Interface.

  • Only available when the reviewInVerify parameter is set to true.

 
"verifyUrl": "https://verify.globalvision.co/inspection/7c591d94-bd8f-/result"

Verify Report Generated

  • This parameter shows whether a new report has been created after reviewing the inspection results in the Verify UI. It switches from false to true when operators generate the report within the Verify UI.

  • Only available when the reviewInVerify parameter is set to true.

 
"verifyReportGenerated": false

Graphics Differences

Individual Differences

Every difference found by the graphics inspection will be shown with the following info:

  • Indexes (Index, matchIndex, diffIndex) to individually identify each difference

  • Difference Coordinates

    • location -> boundingBox contains the coordinates of where to find the difference in each file, Master and Sample

    • pageNumber shows the page where the difference was found on both the Master and Sample files

 
{
    "index": 0,
    "master": {
        "location": {
           "boundingBox": {
                  "bottom": 24.48,
                  "left": 110.88,
                  "right": 129.84,
                  "top": 18.48
                   },
     "pageNumber": 1
                   }
                },
      "matchIndex": 0,
      "sample": {
         "location": {
             "boundingBox": {
                  "bottom": 24.48,
                  "left": 110.88,
                  "right": 129.84,
                  "top": 18.48
                   },
      "pageNumber": 1
                    }
                  },
      "diffIndex": 1
}

Graphics Inspection Summary

Match Details

  • confidence shows the confidence level in 0 → 1 scale

  • confidenceLevel translates the confidence to a High, Medium, Low scale

  • masterLocation, sampleLocation, and pageNumber show the coordinates of the overall graphics match on both the master and sample files

 
"matchDetails": [
     {
        "confidence": 0.9941202998161316,
        "confidenceLevel": "High",
           "masterLocation": {
               "boundingBox": {
                  "bottom": 792,
                  "left": 0,
                  "right": 612,
                  "top": 0
                  },
        "pageNumber": 1
            },
           "sampleLocation": {
               "boundingBox": {
                  "bottom": 792,
                  "left": 0,
                  "right": 612,
                  "top": 0
                  },
        "pageNumber": 1
           }
        }
    ]

Graphics Inspection Summary

Inspection Details

  • graphicsDifferencesAmount shows the number of differences found by the graphics inspection

  • graphicsFilesNotComparable informs if the inspection was successful or not:

    • false means that the inspection found a graphics match and ran successfully

    • true means that the algorithm wasn’t able to match the master and sample files to run the inspection. When this happens, the PDF report will show “No Differences Found”

 
"graphicsDifferencesAmount": 12,
"graphicsFilesNotComparable": false