Redact image attachment

URL

POST https://api.complycube.com/v1/documents/:id/redact

Redacts all instances of document image attachments, including those that were used in checks.

Headers

Name	Type	Description
Content-Type*	string	The content-type must always be set to application/json.
Authorization*	string	The API live or test key.

Path parameters

Name	Type	Description
id*	string	The ID of the document.

Body

Name	Type	Description
attributes*	array	The list of attributes to redact from the document image.

Attributes

Event	Description
images	This will redact the entire front and back images of the document.

Example request

cURL

curl -X POST https://api.complycube.com/v1/documents/{:documentId}/redact \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
               "attributes": [
                      "images"
               ]
        }' 

Example response

Success (200)

{}