Document - Delete

Purpose

To delete a Document resource which originated from your internal system by lookup from the ID in your internal system. This deletes both the Document resource, and it's underlying binary file on Incentify block storage.

Request

Endpoint

DELETE /document/{internal_document_id}

Authentication

Include your API Key within the x-api-key header as described here.

Parameters

There are no parameters for this method. The internal_document_id should be provided in the final path segment of the URI.

Request Body

Do not provide a request body when calling this method.

Successful Response

If successful, this method returns an http code of 204 and an empty response body:

Response Body

{
}

Error Response

If the request has invalid fields/values, this method returns an http code of 400 and response body with the following structure:

Error Response Body

{
    "code":400,
    "success":false,
    "data": {},
    "errors": [
        "text describing error here"
    ]
}

Properties

The following table defines the properties that appear in this resource:

Key	Type	Definition
code	integer	HTTP Status Code (ie; 200, 403, etc).
success	boolean	Either true (success) or false (fail).
errors	[string, string, string...]	If the request fails, this will contain information about the error.