Listar

Listar Documentos

Este endpoint permite que você recupere uma lista de documentos que foram submetidos à plataforma. É útil para visualizar e gerenciar os documentos que estão pendentes, foram assinados ou rejeitados.

Nome	Tipo	Obrigatoriedade	Descrição
start_date	String	Opcional	Data de início para filtrar documentos. Formato exemplo: 2023-01-01.
end_date	String	Opcional	Data de término para filtrar documentos. Formato exemplo: 2023-01-01.

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

Parâmetros Bodyapplication/json

Exemplo

{
    "start_date": "2024-01-01",
    "end_date": "2024-08-15"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Listar

application/json

Body

Exemplo

{
    "data": [
        {
            "id": "a15bb069-d509-482d-badd-1506a14f969d",
            "title": "demo.pdf",
            "document_url": "https://veridca-contracts.s3",
            "document_url_blockchain": null,
            "status": "processing",
            "pdf_password": null,
            "message": null,
            "storage_type": "on-chain",
            "blockchain_type": "polygon",
            "smart_contract_type": "NFT",
            "signature_type": "digital",
            "origin": "web",
            "signers": [
                {
                    "id": "b969d03a-0081-471d-99e3-541d8c44102b",
                    "name": "Assinante de Teste",
                    "email": "teste@gmail.com",
                    "request_document": true,
                    "document": {
                        "type": "cpf",
                        "number": "12345678910"
                    },
                    "phone": [],
                    "validation_type": "adrc",
                    "type": "Assinante",
                    "requirement": "mandatory",
                    "signature_status": "pending",
                    "signed": false,
                    "signed_at": null
                }
            ],
            "documents_updates": [],
            "created_at": "2024-08-13 14:48:39",
            "updated_at": "2024-08-13 14:48:49",
            "draft_date": "2024-08-13 14:48:39",
            "processing_date": "2024-08-13 14:48:49",
            "canceled_at": null,
            "completed_at": null,
            "overdue_at": null
        }
    ],
    "from": 1,
    "last_page": 1,
    "per_page": 10,
    "to": 7,
    "total": 7,
    "current_page": 1
}

Listar Documentos#

Requisição

Códigos de solicitação

Respostas

Listar Documentos