Documentos
Eliminar documento
Eliminar um documento que carregaste, juntamente com os seus resultados extraídos
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 um documento que carregaste com Carregar documento. Usa-o quando
carregaste um ficheiro para o perfil errado. A Aniva elimina o ficheiro e todos os valores extraídos dele.
Os valores também desaparecem da app Aniva do membro.
Requer o âmbito
documents_upload no grupo de perfis em que o documento foi carregado.
De seguida, a Aniva envia o webhook document.deleted para os endpoints que receberam
o último evento de resultados do documento. Uma eliminação não pode ser anulada.
Pedido
Parâmetros de caminho
Resposta
Em caso de sucesso, a API devolve200 OK.
Respostas de erro
| Estado | Descrição |
|---|---|
400 | Formato de ID inválido. |
403 | A tua chave de API não tem o âmbito documents_upload. |
404 | Nenhum documento carregado num dos teus grupos de perfis tem este ID. |
500 | Erro interno do servidor. |
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
}