---
agentTools:
  projectIndex: https://contratosdigitais.readme.io/llms.txt
---

# Capturar documento

Captura um documento e retorna todos os seus dados.

[block:callout]
{
  "type": "warning",
  "title": "Rate Limit",
  "body": "Essa rota possui um limite de requisições.\nPara saber qual o limite dessa e demais rotas acesse: [Rate Limit](https://contratosdigitais.readme.io/reference/rate-limit)"
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Contratos Digitais",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.contratosdigitais.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "api_token",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/documents/capture/{id}": {
      "post": {
        "summary": "Capturar documento",
        "description": "Captura um documento e retorna todos os seus dados.",
        "operationId": "capturar-documento",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "O ID do documento a ser capturado.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"id_documento\": 12345,\n\t\"id_pasta\": 102030,\n\t\"nome_documento\": \"Teste\",\n\t\"data_hora_criacao\": \"2020-10-26 03:43:53\",\n\t\"data_limite\": \"2020-11-01\",\n\t\"status\": \"processo\",\n\t\"mensagem\": \"Segue documento para assinatura\",\n\t\"tags\": \"tag1, tag2\",\n\t\"documento_original\": \"https://app.contratosdigitais.com/files/documentos/02973dfe6fbd29c6f9972a264c4c4219.pdf\",\n\t\"documento_finalizado\": null,\n\t\"data_hora_finalizacao\": null,\n\t\"hash_sha256\": \"a5d79e20eef97ffc8b49178bc98a13ee7fd85933203b5fbfd3415ec4ce173481\",\n\t\"hash_sha512\": \"5e4911d8ad9c85b046434f418bf317735aa23f5dded7b7073a4758a737a07c9216600daf08f06ff58ccadc271603224d6d0a60c50f9ab6bd1d37646c04b15831\",\n\t\"signatarios\":[\n\t\t{\n\t\t\t\"id_signatario\": 45678,\n\t\t\t\"nome\": \"João Silveira\",\n\t\t\t\"email\": \"joao.silveira@gmail.com\",\n\t\t\t\"cpf\": \"111.222.333-44\",\n\t\t\t\"telefone\": \"(99)99999-9999\",\n\t\t\t\"tipo_assinatura\": \"Assinar\",\n\t\t\t\"forma_assinatura\":\"token\",\n\t\t\t\"data_hora_assinatura\": null\n\t\t},\n\t\t{\n\t\t\t\"id_signatario\": 10223,\n\t\t\t\"nome\": \"Maria Costa\",\n\t\t\t\"email\": \"maria.costa@gmail.com\",\n\t\t\t\"cpf\": \"999.888.777-66\",\n\t\t\t\"telefone\": \"(99)98888-8888\",\n\t\t\t\"tipo_assinatura\": \"Assinar\",\n\t\t\t\"forma_assinatura\": \"token\",\n\t\t\t\"data_hora_assinatura\": \"2020-10-27 11:54:21\"\n\t\t}\n\t]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id_documento": {
                      "type": "integer",
                      "example": 12345,
                      "default": 0
                    },
                    "id_pasta": {
                      "type": "integer",
                      "example": 102030,
                      "default": 0
                    },
                    "nome_documento": {
                      "type": "string",
                      "example": "Teste"
                    },
                    "data_hora_criacao": {
                      "type": "string",
                      "example": "2020-10-26 03:43:53"
                    },
                    "data_limite": {
                      "type": "string",
                      "example": "2020-11-01"
                    },
                    "status": {
                      "type": "string",
                      "example": "processo"
                    },
                    "mensagem": {
                      "type": "string",
                      "example": "Segue documento para assinatura"
                    },
                    "tags": {
                      "type": "string",
                      "example": "tag1, tag2"
                    },
                    "documento_original": {
                      "type": "string",
                      "example": "https://app.contratosdigitais.com/files/documentos/02973dfe6fbd29c6f9972a264c4c4219.pdf"
                    },
                    "documento_finalizado": {},
                    "data_hora_finalizacao": {},
                    "hash_sha256": {
                      "type": "string",
                      "example": "a5d79e20eef97ffc8b49178bc98a13ee7fd85933203b5fbfd3415ec4ce173481"
                    },
                    "hash_sha512": {
                      "type": "string",
                      "example": "5e4911d8ad9c85b046434f418bf317735aa23f5dded7b7073a4758a737a07c9216600daf08f06ff58ccadc271603224d6d0a60c50f9ab6bd1d37646c04b15831"
                    },
                    "signatarios": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id_signatario": {
                            "type": "integer",
                            "example": 45678,
                            "default": 0
                          },
                          "nome": {
                            "type": "string",
                            "example": "João Silveira"
                          },
                          "email": {
                            "type": "string",
                            "example": "joao.silveira@gmail.com"
                          },
                          "cpf": {
                            "type": "string",
                            "example": "111.222.333-44"
                          },
                          "telefone": {
                            "type": "string",
                            "example": "(99)99999-9999"
                          },
                          "tipo_assinatura": {
                            "type": "string",
                            "example": "Assinar"
                          },
                          "forma_assinatura": {
                            "type": "string",
                            "example": "token"
                          },
                          "data_hora_assinatura": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "5ff76d381b78e8006df596b0:5ff7782c62cb43006bb659bd"
}
```