Parentes, Colegas e Pessoas Ligadas à Pessoa
Pessoas ligadas à pessoa consultada: parentes, cônjuge, quem mora no mesmo endereço, vizinhos, colegas de trabalho e de faculdade e sócios, com a relação, se o vínculo é direto e o período. Consulta-se pelo CPF.
POST/v1/relacionamentos-pessoais/consultas
- Órgão
- Registros públicos de parentesco, endereço, trabalho e estudo
- Prazo máximo
- 180 s
- Não entrega
Campos do corpo
cpfobrigatórioCPF, com ou sem máscara
CPF da pessoa consultada.
referenciaopcionalTexto, até 80
Seu identificador. Volta na resposta, no webhook e no histórico.
filtroopcionalObjeto
Devolve só os itens de
detalhe.itensque batem:{"campo": valor}.ordenaropcionalNome de um campo do item
-na frente para a ordem decrescente.limiteopcionalInteiro de 1 a 1000
Quantos itens devolver.
Resultados possíveis
dadossem_registros
Decida pelo campo codigo. Consulta que o órgão não respondeu volta como sem_retorno ou em_processamento e não é cobrada.
O que vem em detalhe
detalhe.dados
relacionamentosRelacionamentosparentesParentesconjugesCônjugesmoramMesmoEnderecoMoram no mesmo endereçovizinhosVizinhoscolegasTrabalhoColegas de trabalhocolegasFaculdadeColegas de faculdadeparceirosNegocioParceiros de negócio
detalhe.itens, um por registro
relacaoRelaçãocpfCPFtipoDocumentoTipo de documentopaisDocumentoPaís do documentovinculoVínculoinicioIníciofimFimregistradoEmRegistrado ematualizadoEmAtualizado em
Cada campo só é enviado quando o órgão preencheu.
Observações
- CPF de terceiros vem inteiro e formatado.
- Para processos dos familiares, use
processos-familiares.