Redact check outcome

This endpoint only applies to checks of type document_check.

It redacts selected fields from the completed check outcome, including extracted document data and extracted image features.

For the wider flow and result structure, see Document Check.

For product guidance on redaction, see the redaction guide.

URL

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

Redacts selected attributes and image features from the outcome of the specified Document Check.

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 check.

Body

Name	Type	Description
attributes	array [string]	The list of attributes to redact from the document image.
images	array [string]	The list of images to redact from the document image.

Attributes

Event	Description
address	Redacts the address.
birthPlace	Redacts the birth place.
dob	Redacts the date of birth.
documentDiscriminator	Redacts the document discriminator.
documentNumber	Redacts the document number.
expirationDate	Redacts the expiration date.
firstName	Redacts the first name.
gender	Redacts the gender.
healthInsuranceNumber	Redacts the health insurance number.
issuingAuthority	Redacts the issuing authority.
issuingCountry	Redacts the issuing country.
issuingDate	Redacts the issuing date.
issuingPlace	Redacts the issuing place.
lastName	Redacts the last name.
mrz	Redacts the MRZ.
nationality	Redacts the nationality.
personalNumber	Redacts the personal number.
taxIdentificationNumber	Redacts the tax identification number.

Images

Event	Description
all	Redacts the entire front and back images of the document.
face	Redacts the faces or portraits.
securityElements	Redacts the security elements.
signature	Redacts the signature.
code	Redacts codes (e.g. barcodes, QR codes).
fingerprint	Redacts fingerprints.

Example request

cURL

curl -X POST https://api.complycube.com/v1/checks/{:checkId}/redact \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "attributes": [
               "documentNumber",
               "personalNumber",
               "issuingAuthority"
           ],
          "images": [
               "face"
           ]
        }'

Example response

Success (200)

{}