Esta seção da documentação descreve detalhadamente os campos utilizados nas requisições e respostas da API, juntamente com as regras de negócio associadas a cada um deles. Aqui, você encontrará informações sobre:
- Definições dos campos: Nome, tipo de dado e formato esperado.
- Validações aplicadas: Regras obrigatórias, valores permitidos, e limites de tamanho ou intervalo.
- Dependências e relações: Campos que dependem de outros ou influenciam o comportamento da API.
- Comportamento padrão: Valores atribuídos automaticamente e tratamento de dados opcionais.
Nosso objetivo é garantir que você tenha uma compreensão clara de como interagir com os campos da API e evitar erros comuns durante a integração. Certifique-se de consultar esta seção ao construir ou validar suas requisições.
Campos e Regras de Negócio:
Descrição dos Campos
| Campo | Descrição | Tipo |
|---|---|---|
| status | A alteração desse campo determina se deseja cancelar ou finalizar o documento e está disponível apenas na atualização do documento com status em progresso (running). | string |
| filename | Define o nome do Arquivo com extensão, está disponível apenas na criação do documento. | string |
| content_base64 | Define o arquivo a ser adicionado ao processo via upload, está disponível apenas na criação de documentos que não possuam template ou duplicate. | string |
| template | Define parâmetros para a criação de um documento a partir de um modelo, está disponível apenas na criação de documentos que não possuam content_base ou duplicate. | object |
| duplicate | Define parâmetro para criar um documento a partir de um documento finalizado, está disponível apenas na criação de documentos que não possuam content_base64 ou template. | object |
| metadata | Metadados do documento, os dados cadastrados serão enviados com o documento nos webhooks para facilitar a identificação deles pelo sistema que implementa a integração. | object |
Regras de Negócio para os campos
Campo | Regras de Negócio |
|---|---|
status | Valores possíveis: |
filename |
|
content_base64 | Utilize o quando tiver o base64 do arquivo a ser assinado. Veja a estrutura na página de referência. |
template | O objeto deve conter a chave do template/modelo e os dados para a criação do arquivo. Veja a estrutura na página de referência. |
duplicate | O objeto deve conter a chave do documento que será duplicado, este deve estar finalizado. Veja a estrutura na página de referência. |
metadata | Não há validação dos dados que deseje salvar no documento. |
Regras dos campos para a Criação
| Campo | Obrigatório | Disponível | Valor Padrão |
|---|---|---|---|
| status | NÃO | NÃO | - |
| filename | SIM | SIM | null |
| content_base64 | Apenas via Upload | Apenas via Upload | null |
| template | Apenas via Modelo | Apenas via Modelo | null |
| duplicate | Apenas via Duplicar | Apenas via Duplicar | null |
| metadata | NÃO | SIM | {} |
Regras dos campos para a Atualização
| Campo | Obrigatório | Disponível |
|---|---|---|
| status | NÃO | SIM |
| filename | - | NÃO |
| content_base64 | - | NÃO |
| template | - | NÃO |
| duplicate | - | NÃO |
| metadata | NÃO | SIM |
Conte com a nossa ajuda!
Estamos comprometidos em fornecer a você todas as ferramentas necessárias para simplificar e aprimorar seus processos de assinatura eletrônica. Não hesite em nos contatar se tiver alguma dúvida ou precisar de assistência adicional. Estamos sempre disponíveis através do e-mail [email protected].