Documentos Substitutos

Título: Documentos Substitutos
Descrição: Regra para aceitação de documentos substitutos.

Propriedades

Selecione os documentos aceitos

Tipo: select
Nome: DOCUMENTS_IDS
Múltipla Seleção: Sim
Referência de Recursos: DOCUMENTS_IDS

Selecione as declarações aceitas

Tipo: select
Nome: DECLARATIONS_IDS
Múltipla Seleção: Sim
Referência de Recursos: COMPANY_DECLARATIONS_IDS

Selecione os tipos de documento customizados aceitos

Tipo: select
Nome: CUSTOM_DOCUMENT_TYPE_IDS
Múltipla Seleção: Sim
Referência de Recursos: CUSTOM_DOCUMENT_TYPE_IDS
Feature obrigatória: CUSTOM_DOCUMENT_TYPES — só aparece para empresas com essa feature contratada. Sem a feature, este seletor não aparece na tela de regras; as propriedades de catálogo e de declaração acima continuam normais — só esta propriedade é restrita pela feature, não a regra inteira.

`DOCUMENTS_IDS` aceita tipo de documento, não só id

Ao enviar esta regra pela API (campo rules de POST /v1/api/documents, POST /v1/api/competencies/{competencyId}/participants/{participantId}/documents ou da rota split-and-redistribute), DOCUMENTS_IDS aceita tanto um tipo de documento ("CNH", "RG") quanto um ObjectId — a validação busca documentos no banco por tipo e substitui o tipo pelo id correspondente por baixo dos panos. As demais propriedades desta família de regras são mais restritas:

campo	aceita	erro quando inválido
`DOCUMENTS_IDS`	um tipo de documento (`"CNH"`, `"RG"`, …) ou um ObjectId	`Documentos não encontrados: X`
`DECLARATIONS_IDS`	só ObjectId	`IDs de declaração inválidos: X`
`LOCATIONS_IDS` (regra Localização)	só ObjectId, e precisa existir	`Localizações não encontradas: X`

Exemplos

Aceita CNH como substituto do RG, referenciando pelo tipo do documento — sem precisar ter o id em mãos:

curl --request POST 'https://api.dynadok.com/v1/api/documents' \
  --header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE' \
  --form 'files=@"/caminho/rg.pdf"' \
  --form 'type="RG"' \
  --form 'rules="[{\"type\":\"SUBSTITUTE_DOCUMENTS\",\"inputName\":\"DOCUMENTS_IDS\",\"inputValue\":[\"CNH\"]}]"'

Aceita como substituto um documento específico já cadastrado (por ObjectId) e uma declaração — duas propriedades da mesma regra, dois itens com o mesmo type e inputName diferente:

curl --request POST 'https://api.dynadok.com/v1/api/documents' \
  --header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE' \
  --form 'files=@"/caminho/rg.pdf"' \
  --form 'type="RG"' \
  --form 'rules="[{\"type\":\"SUBSTITUTE_DOCUMENTS\",\"inputName\":\"DOCUMENTS_IDS\",\"inputValue\":[\"6500a1b2c3d4e5f600000010\"]},{\"type\":\"SUBSTITUTE_DOCUMENTS\",\"inputName\":\"DECLARATIONS_IDS\",\"inputValue\":[\"6500a1b2c3d4e5f60000000e\"]}]"'

Documentos Substitutos

Propriedades​

Selecione os documentos aceitos​

Selecione as declarações aceitas​

Selecione os tipos de documento customizados aceitos​

DOCUMENTS_IDS aceita tipo de documento, não só id​

Exemplos​