Skip to main content
DELETE
/
apps
/
{client_id}
/
providers
/
{provider_id}
/
activation
/
documents
/
{document_id}
curl -X DELETE \
  -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/spid-ig/activation/documents/0567eeb3-eda7-489a-9ba8-84f0ae3f301e"
{
  "deleted": true
}
Removes a single uploaded document from the provider’s upload step. Use this to clean up a document that was uploaded in error or to tidy up entries left behind by a rejection cycle.
Only pending and rejected documents can be deleted. Once a document has transitioned to processed (approved by the Hopae review team), it is part of the accepted evidence set and deletion is blocked with 409 RESOURCE_CONFLICT — contact support if you believe it was approved in error.

Request

Authorization
string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.

Path parameters

client_id
string
required
Client identifier of the app.
provider_id
string
required
Provider identifier (e.g., ftn, spid-ig, idin). Must match the provider the document was uploaded against.
document_id
string
required
Identifier of the document to delete. Obtain it from the documentId field of the Upload Activation Documents response or from upload.uploaded[].documentId in Get Activation Steps.

Response

deleted
boolean
Always true when the request succeeds.

Errors

CodeHTTPWhen you see it
RESOURCE_NOT_FOUND404The app was not found, or no document with this document_id exists under the given provider_id. A document uploaded against a different provider on the same app is not reachable through this URL.
RESOURCE_CONFLICT409The document’s state is processed and cannot be deleted.
curl -X DELETE \
  -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/providers/spid-ig/activation/documents/0567eeb3-eda7-489a-9ba8-84f0ae3f301e"
{
  "deleted": true
}