Redact images

Redact scope

The Redact service is currently available only for hiding the BSN number and the photo (including hologram) in Dutch ID document images. If you need this feature for other fields or documents, you need to contact us by creating a support ticket in the Signicat Dashboard.

You can use the Redact service to mask parts of the images of the ID document that is used during a verification process. This is useful, for example, to comply with privacy laws in some countries.

Here is an example of a redacted image, where a black square covers the BSN number and the photo (including the hologram) in a Dutch passport (see more examples further down):

Redacted

Request

You can currently redact only the BSN number (personalIdentificationNumber) and the photo (photo) on Dutch ID documents.

There are three different ways to do this (see below request examples).

Redact an image directly

In this example, you apply the redaction on an image that is sent directly in the request:

{
    "fieldsToRedact":["personalIdentificationNumber"],
    "redactionLevel": "standard",
    "frontImage":"data:image/png;base64,<BASE64IMAGE>",
    "backImage":"data:image/png;base64,<BASE64IMAGE>",
    "documentType":"passport",
    "documentCountry":"NLD"
}

Redact an image from a dossier

In this example, the redaction is appplied on an image from a dossier:

{
    "dossierId":"37191afe-25b3-4c30-b42a-b0ab64aa1d64",
    "fieldsToRedact":["personalIdentificationNumber"],
    "redactionLevel": "standard",
    "documentType":"passport",
    "documentCountry":"NLD"
}

Redact an image from a process

In this example, the redaction is applied on an image from a process:

{
    "dossierId":"37191afe-25b3-4c30-b42a-b0ab64aa1d64",
    "processId":"8afb3ac6-6780-42e4-bbc2-3713e2f6d97c",
    "fieldsToRedact":["photo", "personalIdentificationNumber"],
    "redactionLevel": "standard",
    "documentType":"passport",
    "documentCountry":"NLD"
}

Redaction level (size)

If the field on the ID document image is not fully redacted, you may change the redaction size using the redactionLevel parameter from standard size (smallest) to one of the bigger sizes for the bounding box. This increases the bounding size in all directions.

You can choose between the following sizes:

• standard (default)
• medium
• high
• veryHigh

Here is an example:

{
    "dossierId":"37191afe-25b3-4c30-b42a-b0ab64aa1d64",
    "fieldsToRedact": [
        "personalIdentificationNumber",
        "photo"
    ],
    "redactionLevel": "medium"
}

Note

Before you decide on a size, you should test the Redaction service to see how the images look in the response.

Response

Here is a response example:

{
    "success": true,
    "redactedFrontImage": "data:image/jpeg;base64,<BASE64IMAGE>",
    "redactedBackImage": "data:image/jpeg;base64,<BASE64IMAGE>"
}

The image follows in the response.

If the success is false, no image will be returned in the response:

{
    "success": false
}

Passport example

Here is an example of a Dutch passport where the BSN number and photo is redacted.

Front page before redaction:

Dutch passport before redaction

Front page after redaction:

Dutch passport after redaction

Back page before redaction:

Dutch passport before redaction

Back page after redaction:

In this example the QR code containing the personal ID number is also hidden:

Dutch passport after redaction