API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page
  • URL
  • Headers
  • Path parameters
  • Body
  • Example request
  • Example response

Was this helpful?

  1. Core resources
  2. Checks

Redact check outcome

PreviousValidate check outcomeNextList checks

Last updated 1 year ago

Was this helpful?

This will only apply to .

URL

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

Redacts attributes and image features from the outcome of the specified 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

string

images

string

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

{}

The list of to redact from the document image.

The list of to redact from the document image.

Document Checks
attributes
images