# Preparação de documento(s)
A preparação de documentos é um processo destinado a obter um arquivo já preparado para receber a assinatura e também o hash a ser assinado.
O processo é feito de forma assíncrona. Ao iniciar-se o processo é gerado um TCN (Token de controle da transação), o TCN deve ser utilizado para identificar a transação no momento da recuperação do documento.
Os campos retornados para cada documento são:
**prepared\_checksum** - Hash para verificação da integridade do documento preparado;
**prepared\_result** - URL para download do documento preparado;
**prepared\_hash** - Hash a ser assinado e incorporado ao documento preparado.
`POST` `http://cess.local/signature-service`
#### Headers
| Name | Type | Description |
| ------------- | ------ | ------------------------------------------------------------- |
| Authorization | string | Basic, Bearer ou VCSchema (Veja "Autenticação e Autorização") |
| Content-Type | string | application/json |
| Accept | string | application/json |
#### Request Body
| Name | Type | Description |
| ---------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| certificate\_alias | string | Identifica qual certificado será utilizado para realizar assinatura. |
| documents\_destination | string | - AWS\_S3 (o arquivo assinado será salvo no bucket S3)
- GCP\_STORAGE (o arquivo assinado será salvo no bucket Google Cloud Platform Storage)
|
| mode | string | Modo de operação
- sync
- async
|
| type | string | Tipo de assinatura
- CMS-attached
- CMS-detached
- PDFSignature
- CAdEs-attached
- CAdEs-detached
- PAdEs
- XAdES
|
| notification\_callback | string | URL de callback para notificação, o sistema irá notificar quando o processo de assinatura for finalizado, será feito uma requisição HTTP(s) - POST na URL informada, na chamada será concatenado o código transação no final da url informada neste parâmetro.
URL informada:
URL que será feita a requisição HTTP: ?tcn=tcn\_aqui\_123456
|
| policy | string | Políticas por tipo de assinatura
- CMS:
- Default ( Assinatura padrão CMS )
- TSA ( Assinatura padrão CMS incluindo assinatura da carimbadora do tempo )
- PDFSignature:
- Default ( Assinatura padrão PDF - Adobe )
- TSA ( Assinatura padrão de PDF - Adobe incluindo assinatura da carimbadora do tempo )
- CAdEs/PAdEs:
- AD\_RB ( ICP Brasil )
- AD\_RT ( ICP Brasil )
- XAdES:
- AD\_RB
- AD\_RT
- AD\_RC
- AD\_RA
|
| hash\_algorithm | string | Algoritmo de hash que será utilizado na assinatura (SHA1,SHA256, SHA384 ou SHA512) |
| signature\_settings | object | Parâmetros adicionais de configuração de assinatura, devem ser enviados para configuração de assinatura visível (PDFSignature/PAdES)
- id ( Identificador da configuração de assinatura )
- contact ( Contato do assinante )
- location ( Localização da assinatura, Ex: Washington-DC )
- reason ( Motivo da assinatura )
-visible\_signature (true or false, desabilita a assinatura visível)
- visible\_sign\_page ( Página onde será inserido a assinatura visível. OBS: Este é um campo do tipo inteiro. Envie 1 para a primeira página, -1 para última e "\*" ou -100 para todas as páginas.)
- visible\_sign\_x ( Coordenada X na página onde será inserido a assinatura visível )
- visible\_sign\_y ( Coordenada Y na página onde será inserido a assinatura visível )
- visible\_sign\_width ( Largura da imagem da assinatura visível )
- visible\_sign\_height ( Altura da imagem da assinatura visível )
- visible\_sign\_scale ( Escala (%) da imagem da assinatura visível )
- visible\_sign\_img ( Bytes de uma imagem PNG no formato DATA URI com a assinatura do usuário - RFC 2397 )
- extraInfo (Array para adicionar metadados no PDF, útil para prescrição médica. Contendo as chaves name e value. Exemplo: "extraInfo": \[{ "name": "2.16.1.12.1.2", "value": "Atestado Médico" }] )
-prepare\_fields\_value (Array para adicionar valores aos formulários do PDF. Contendo as chaves name, type e value. Exemplo: "prepare\_fields\_value": \[ { "name": "03\_Cidade Local de Atendimento", "type": "text", "value": "Goiania" }] )
Parâmetros adicionais para configuração de assinatura devem ser enviados para assinatura padrão XAdES
- tag\_name (Nome da tag a ser assinada)
- tag\_id (Id da tag a ser assinada)
|
| auto\_fix\_document | boolean | Habilita autocorreção do documento caso disponível |
| tsa\_server\_id | string | Identificador da carimbadora do tempo |
| tsa\_hash\_algorithm | string | Algoritmo de hash que será utilizado na assinatura do carimbo do tempo (SHA1,SHA256, SHA384 ou SHA512) |
| documents\_source | string | Origem dos documentos:
- DATA\_URL ( Arquivo encodado na URL - )
- FILE\_PATH ( Caminho do arquivo local do arquivo )
- UPLOAD\_REFERENCE ( O conteúdo do arquivo deverá ser enviado posteriormente via API )
- AWS\_S3 (nome do objeto no bucket do S3)
- GCP\_STORAGE (nome do objeto no bucket do GCP)
- HASH (o hash deverá ser em hexadecimal - enviado na chave data de documents)
|
| documents | string | Caso o documents\_source seja do tipo DATA\_URL ou FILE\_PATH esse parâmetro deve ser enviado.
Lista de especificação de documento(s) a ser(em) assinado(s), caso seja enviado mais de um item na lista, automaticamente a requisição será reconhecida como transação de assinatura em lote.
- id ( Identificador do documento na transação )
- data ( Conteúdo compatível com especificado no data source )
- destination\_file\_name (Caso esteja utilizando documents\_destination com valor AWS\_S3 ou GCP\_STORAGE, poderá ser definido o nome do objeto. Se o nome não for definido, será criado um identificar aleatório com a seguinte lei de formação: ano/mês/dia/timestamp\_númeroAleatório8dígitos
|
{% tabs %}
{% tab title="200 " %}
```json
{
"certificate_alias": "",
"type": "PAdEs",
"hash_algorithm": "SHA256",
"auto_fix_document": true,
"mode":"async",
"signature_settings": [{
"id": "default",
"contact": "123456789",
"location": "GoianiaGO",
"reason": "Aprovação de documento"
}],
"documents_source": "UPLOAD_REFERENCE"
}
```
{% endtab %}
{% endtabs %}
### Download do documento preparado
Para fazer o download do documento preparado, basta acessar a url retornada em **prepared\_result**.
`GET` `http://cess.local/file-transfer//?prepared=true`
#### Path Parameters
| Name | Type | Description |
| ---------------------------------------------- | ------ | ----------- |
| tcn\* | string | |
| document\_id\* | String | |
{% tabs %}
{% tab title="200 " %}
```
bytes do documento preparado
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.vaultid.com.br/workspace/cess/api/preparacao-de-documento-s.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.