API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox 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
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page
  • Delete image attachment
  • Example request

Was this helpful?

  1. Documents

Delete image attachment

Delete image attachment

DELETE https://api.complycube.com/v1/documents/:id/:side

Deletes an existing image attachment. You will not be able to delete a document image once used to perform a check.

Path Parameters

Name
Type
Description

id

string

The ID of the document.

side

string

The side of the document to delete. Valid values include: 1. front 2. back

Headers

Name
Type
Description

Authorization

string

The API live or test key

Example request

curl -X DELETE https://api.complycube.com/v1/documents/{:documentId}/{:side} \
     -H 'Authorization: <YOUR_API_KEY>'
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

await complycube.document.deleteImage("DOCUMENT_ID","DOCUMENT_SIDE");
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

cc_api.documents.deleteImage('DOCUMENT_ID','DOCUMENT_SIDE')
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$ccapi->documents()->deleteImage('DOCUMENT_ID', 'DOCUMENT_SIDE');
PreviousDownload image attachmentNextDelete a document

Last updated 4 years ago

Was this helpful?