POST PF/ConsultaPFVinculosPessoa

A consulta retorna dados de pessoas com vinculação de parentesco, sociedade, mesmo endereço e/ou telefone ao do CPF pesquisado.

Request Information

URI Parameters

None.

Body Parameters

TransUnion.Consultas.DTO.Parametros.APIBaseEstatica.ParametrosEntradaPF
NameDescriptionTypeAdditional information
Token

string

None.
CPF

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Token": "sample string 1",
  "CPF": "sample string 2"
}

application/xml, text/xml

Sample: 
<ParametrosEntradaPF xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="BaseEstatica.API">
  <CPF>sample string 2</CPF>
  <Token>sample string 1</Token>
</ParametrosEntradaPF>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Lista Vinculos Pessoa

TransUnion.Consultas.BLL.APIServiceReference.ResultadoListaVinculosPessoa
NameDescriptionTypeAdditional information
RETORNO

string

None.
PESSOAS

Collection of TransUnion.Consultas.BLL.APIServiceReference.PESSOA_VINCULADA

None.
ERRO

TransUnion.Consultas.BLL.APIServiceReference.ERRO

None.

Response Formats

application/json, text/json

Sample: 
{
  "RETORNO": "sample string 1",
  "ERRO": {
    "CODIGO": 1,
    "MENSAGEM": "sample string 2"
  },
  "PESSOAS": [
    {
      "DS_AUX_VINCULO": "sample string 1",
      "DT_RECENCIA": "2025-12-19T15:58:25.9184704-03:00",
      "FG_OBITO": true,
      "ID_AUX_VINCULO": 1,
      "NM_COMPLETO": "sample string 3",
      "NR_ANO_OBITO": "sample string 4",
      "NR_CPF": 1,
      "ERRO": {
        "CODIGO": 1,
        "MENSAGEM": "sample string 2"
      }
    },
    {
      "DS_AUX_VINCULO": "sample string 1",
      "DT_RECENCIA": "2025-12-19T15:58:25.9184704-03:00",
      "FG_OBITO": true,
      "ID_AUX_VINCULO": 1,
      "NM_COMPLETO": "sample string 3",
      "NR_ANO_OBITO": "sample string 4",
      "NR_CPF": 1,
      "ERRO": {
        "CODIGO": 1,
        "MENSAGEM": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<ResultadoListaVinculosPessoa xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="API.ZipOnline">
  <ERRO>
    <CODIGO>1</CODIGO>
    <MENSAGEM>sample string 2</MENSAGEM>
  </ERRO>
  <RETORNO>sample string 1</RETORNO>
  <PESSOAS>
    <PESSOA_VINCULADA>
      <ERRO>
        <CODIGO>1</CODIGO>
        <MENSAGEM>sample string 2</MENSAGEM>
      </ERRO>
      <DS_AUX_VINCULO>sample string 1</DS_AUX_VINCULO>
      <DT_RECENCIA>2025-12-19T15:58:25.9184704-03:00</DT_RECENCIA>
      <FG_OBITO>true</FG_OBITO>
      <ID_AUX_VINCULO>1</ID_AUX_VINCULO>
      <NM_COMPLETO>sample string 3</NM_COMPLETO>
      <NR_ANO_OBITO>sample string 4</NR_ANO_OBITO>
      <NR_CPF>1</NR_CPF>
    </PESSOA_VINCULADA>
    <PESSOA_VINCULADA>
      <ERRO>
        <CODIGO>1</CODIGO>
        <MENSAGEM>sample string 2</MENSAGEM>
      </ERRO>
      <DS_AUX_VINCULO>sample string 1</DS_AUX_VINCULO>
      <DT_RECENCIA>2025-12-19T15:58:25.9184704-03:00</DT_RECENCIA>
      <FG_OBITO>true</FG_OBITO>
      <ID_AUX_VINCULO>1</ID_AUX_VINCULO>
      <NM_COMPLETO>sample string 3</NM_COMPLETO>
      <NR_ANO_OBITO>sample string 4</NR_ANO_OBITO>
      <NR_CPF>1</NR_CPF>
    </PESSOA_VINCULADA>
  </PESSOAS>
</ResultadoListaVinculosPessoa>