Delete image attachment
URL
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.
Headers
Name
Type
Description
Authorization*
string
The API live or test key.
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
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');using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;
var docApi = new DocumentApi(new ComplyCubeClient("<YOUR_API_KEY>"));
await docApi.DeleteImageAsync("DOCUMENT_ID", "DOCUMENT_SIDE");Example response
Last updated
Was this helpful?