Redact fields

Configure fields to be masked from the downloaded document image. For example, you might want to blur the personal number and signature. The text data is still returned in the results request.

POST https://api.cm.com/id-scan/v1/transactions

Request headers

Content-Type: application/json
Authorization: Bearer GENERATED_TOKEN_HERE

{
    "tasks": [
        "document_scan"
    ],
    "settings": {
        "documentScan": {
            "redactFields": [
                "personal_number",
              	"signature"
            ]
        }
    }
}

For a full list of all options see the API reference

Example

When we upload the following document with the above settings.

When we download the document, it will be returned as follows: