Profile Server API
Manual do usuário

Tipos de Documento

As regras que definem cada documento exigido das organizações.

Menu: Tipos de Documento (/document-types)

Um tipo de documento define as regras de uma categoria de documento (ex.: "Alvará de Funcionamento"): se tem validade, se precisa de aprovação, se exige código de autenticidade. As chaves ligadas aqui mudam o formulário de envio na página Documentos.

Técnico e Visualizador só consultam esta tela

Esses perfis veem a lista de tipos (para escolher ao enviar um documento), mas não criam, editam nem excluem tipos — quem mantém o catálogo é o administrador do tenant. Veja Permissões.

Criar um tipo

Clique em Novo tipo e preencha:

CampoObrigatórioObservações
Restrito a um tenantPrimeira chave do formulário, desligada por padrão: o tipo nasce global, visível a todos os tenants. Ligue-a para que só o seu tenant veja o tipo — e também os documentos enviados com ele. Não muda depois de criado.
NomeSimEx.: "Alvará de Funcionamento".
DescriçãoNãoDetalhes sobre o documento.
Dias de validade padrãoNãoCalcula a data de validade no envio, contada da data de emissão (ex.: 365). Quem envia ainda pode ajustar a data.
ObrigatórioMarca o documento como exigido das organizações.
Requer aprovaçãoLigado: documentos deste tipo entram como Pendente e precisam passar por revisão. Desligado: entram já Aprovados, sem revisão — e, se o tipo não tiver validade, só saem do lugar se o documento for excluído.
Tem expiraçãoO envio passa a exigir a data de validade.
Código de autenticidadeO envio passa a exigir o código de autenticidade.
AtivoTipos inativos não aparecem para novos envios (documentos já enviados não são afetados).

A chave Restrito a um tenant só fica indisponível se você estiver representando Todos os tenants no seletor do topo: aí não há um tenant a quem restringir, e o tipo só pode nascer global. Quem tem um único tenant pode ligá-la sem precisar escolher nada no seletor — a restrição vale para o seu tenant.

Editar e excluir

As regras podem ser ajustadas a qualquer momento — valem para os próximos envios. A exceção é Restrito a um tenant: essa não muda depois de criado, porque mudá-la mexeria em quem vê os documentos já enviados — o formulário de edição só mostra qual é a faixa do tipo. A exclusão pede confirmação; prefira desativar um tipo que já tem documentos enviados.