Pular para o conteúdo principal

Titularidade

Título: Titularidade
Descrição: Regra para aceitação de documentos baseado na titularidade.

Nota sobre variantes: a regra tem duas variantes registradas no backend. A variante completa, com as três opções abaixo (incluindo "terceiros"), só é usada para o documento Comprovante de Residência — único caso em que é legítimo o titular do documento ser um terceiro (locador, cônjuge, pai/mãe), mediante comprovação de vínculo. Para todos os demais documentos, o backend usa uma variante padrão em que a opção thirdParties é removida da lista de opções — sobram apenas "Aceitar somente em nome do titular" e "Não verificar". Nessa variante padrão, a propriedade de seleção de declarações abaixo continua declarada no catálogo, mas é inalcançável (a condição que a exibe nunca é satisfeita).

Propriedades​

Aplicação da regra​

  • Tipo: radio
  • Nome: OWNERSHIP_TYPE
  • Valor Padrão: owner
  • Opções:
    • Aceitar somente em nome do titular: owner
    • Aceitar em nome do titular ou de terceiros mediante comprovação de vínculo: thirdParties — disponível apenas na variante usada pelo Comprovante de Residência (ver nota acima)
    • Não verificar: ignore

Selecione as declarações aceitas para comprovação de vínculo​

  • Tipo: select
  • Nome: OWNERSHIP_DECLARATION_IDS
  • Múltipla Seleção: Sim
  • Condições:
    • Quando OWNERSHIP_TYPE é thirdParties
  • Referência de Recursos: COMPANY_DECLARATIONS_IDS

Exemplos​

Aceita somente documentos em nome do titular — o comportamento padrão (owner), enviado explicitamente:

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\":\"OWNERSHIP\",\"inputName\":\"OWNERSHIP_TYPE\",\"inputValue\":[\"owner\"]}]"'

Aceita em nome de terceiros mediante declaração de vínculo. A opção thirdParties só existe na variante da regra usada pelo Comprovante de Residência (ver nota no topo desta página) — em qualquer outro tipo de documento ela não aparece nas opções de OWNERSHIP_TYPE, e OWNERSHIP_DECLARATION_IDS seria inalcançável:

curl --request POST 'https://api.dynadok.com/v1/api/documents' \
  --header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE' \
  --form 'files=@"/caminho/comprovante-residencia.pdf"' \
  --form 'type="COMPROVANTE_RESIDENCIA"' \
  --form 'rules="[{\"type\":\"OWNERSHIP\",\"inputName\":\"OWNERSHIP_TYPE\",\"inputValue\":[\"thirdParties\"]},{\"type\":\"OWNERSHIP\",\"inputName\":\"OWNERSHIP_DECLARATION_IDS\",\"inputValue\":[\"6500a1b2c3d4e5f60000000d\"]}]"'