Documenti
Elimina documento
Elimina un documento che hai caricato, insieme ai relativi risultati estratti
DELETE
/
api
/
v1
/
documents
/
{id}
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
Elimina un documento caricato con Carica documento. Usalo quando
hai caricato un file sul profilo sbagliato. Aniva elimina il file e ogni valore estratto da esso.
I valori vengono rimossi anche dall’app Aniva del membro.
Richiede lo scope
documents_upload sul gruppo di profili in cui il documento è stato caricato.
Aniva invia poi il webhook document.deleted agli endpoint che hanno ricevuto
l’ultimo evento di risultati del documento. L’eliminazione non può essere annullata.
Richiesta
Parametri di percorso
Risposta
In caso di successo, l’API restituisce200 OK.
Risposte di errore
| Stato | Descrizione |
|---|---|
400 | Formato dell’ID non valido. |
403 | La tua chiave API non dispone dello scope documents_upload. |
404 | Nessun documento caricato in uno dei tuoi gruppi di profili ha questo ID. |
500 | Errore interno del server. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}