API Reference
v1.7.3
Search
K

Redact check outcome

This will only apply to Document Checks.
post
https://api.complycube.com
/v1/checks/:id/redact
Redact check outcome
Redacts attributes and image features from the outcome of the specified check.
Parameters
Path
id*
string
The ID of the check.
Header
Content-Type*
string
The content-type must always be set to application/json.
Authentication*
string
The API live or test key.
Body
attributes
string
The list of attributes to redact from the document image.
images
string
The list of images to redact from the document image.
Responses
200
Redaction performed successfully.

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"
]
}'