Veridca
  1. Documentos
Veridca
  • Apresentação
  • Autenticação
    • Login
      POST
    • Refresh
      POST
  • Documentos
    • Novo Documento
      POST
    • Listar
      GET
    • Buscar por ID
      GET
    • Deletar documento
      DELETE
  • Envelope
    • Novo Envelope
      POST
  1. Documentos

Deletar documento

DELETE
/api/v1/documents/{{id_do_documento}}

Deletar Documento#

Este endpoint é utilizado para excluir um documento específico da plataforma Veridca, com base em seu identificador único (ID). Este método é útil quando um documento é criado incorretamente ou não é mais necessário, permitindo a sua remoção de forma eficiente e segura.

Parâmetros:#

id (na URL): Identificador único do documento que se deseja excluir. Este parâmetro é obrigatório e deve ser passado na URL.

Resposta:#

A resposta incluirá uma mensagem de confirmação indicando que o documento foi excluído com sucesso, ou, em caso de erro, uma mensagem indicando o motivo da falha na exclusão.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request DELETE 'https://api.veridca.com.br/api/v1/documents/{{id_do_documento}}' \
--header 'client-id: {{api_client_id}}' \
--header 'client-secret: {{api_secret}}' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Success
application/json
Body

Exemplo
{}
Modificado em 2024-08-19 18:02:07
Página anterior
Buscar por ID
Próxima página
Novo Envelope
Built with