Buscar por ID

GET

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

Buscar Documento por ID

Este endpoint é projetado para recuperar detalhes específicos de um documento baseado no seu identificador único (ID). É útil quando se deseja visualizar informações, status ou conteúdo de um documento individual na plataforma Veridca.

Parâmetros:

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

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET '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

🟢200Buscar por ID

application/json

Body

Exemplo

{
    "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
}

Modificado em 2024-08-19 18:02:07