curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \
-H 'x-api-key: YOUR_API_KEY'{
"confirm_delete": [
"This field is required to delete a finalized report."
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "This report is being deleted. Retry deleting it to finish erasing its files.",
"code": "report_deletion_pending"
}{
"detail": "The report files could not be erased. Please retry deleting the report.",
"code": "report_storage_unavailable"
}Eliminar relatório UIF via API
Elimine na Didit um relatório regulatório em rascunho ou finalizado, com a narrativa copiada, ligações a transações, XML goAML e PDF.
curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \
-H 'x-api-key: YOUR_API_KEY'{
"confirm_delete": [
"This field is required to delete a finalized report."
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "This report is being deleted. Retry deleting it to finish erasing its files.",
"code": "report_deletion_pending"
}{
"detail": "The report files could not be erased. Please retry deleting the report.",
"code": "report_storage_unavailable"
}O que é eliminado
O relatório, a narrativa copiada, os motivos e os restantes campos do relatório, as suas ligações a transações, e o XML e o PDF do goAML gerados. Todas as versões guardadas desses ficheiros são eliminadas. O relatório deixa de aparecer nas listas de relatórios, e os URLs de transferência já emitidos deixam de funcionar. O caso, as transações, as pessoas e as empresas não são eliminados. O relatório não leva consigo os dados deles. A eliminação é permanente e irreversível.Confirmação
Um relatório em rascunho ou validado é eliminado sem corpo de pedido. Para eliminar um relatório finalizado, é necessária uma confirmação explícita:{ "confirm_delete": true }
400 e nada é eliminado.
Se os ficheiros não puderem ser eliminados neste momento
Um503 com code: report_storage_unavailable significa que os ficheiros do relatório não puderam ser eliminados neste momento. O relatório continua no mesmo sítio, por isso repita o pedido. Um 409 com code: report_deletion_pending significa que já existe uma eliminação deste relatório em curso: repita o pedido para a concluir.
Resolver uma eliminação bloqueada
Se a eliminação de uma pessoa, empresa, transação, caso ou sessão devolver409 com code: in_filed_report, a resposta indica os relatórios que contêm os dados. Elimine cada um desses relatórios aqui e, depois, repita a eliminação bloqueada.
Relacionados
Autorizações
A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.
Parâmetros de caminho
UUID da organização.
UUID da aplicação.
UUID do relatório.
"5ec00000-0000-4000-8000-000000000007"
Corpo
Obrigatório apenas para um relatório finalizado.
Defina como true para confirmar que um relatório finalizado e os respetivos ficheiros gerados são eliminados permanentemente.
Resposta
Relatório eliminado, incluindo os seus ficheiros gerados.