POST PF/ConsultaPFPorEmail

A consulta retorna informações de pessoas vinculadas ao e-mail pesquisado, tais como CPF, nome, nome social, signo, sexo, idade e ano de óbito.

Request Information

URI Parameters

None.

Body Parameters

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

string

None.
Email

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Lista Pessoa Email

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

string

None.
PESSOAS

Collection of TransUnion.Consultas.BLL.APIServiceReference.PESSOA_EMAIL

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": [
    {
      "DADOS_PRINCIPAIS": {
        "DS_SEXO": "sample string 1",
        "DS_SIGNO": "sample string 2",
        "DT_NASCIMENTO": "2024-06-30T04:38:06.5891625-03:00",
        "DT_RECENCIA": "2024-06-30T04:38:06.5891625-03:00",
        "FG_OBITO": true,
        "NM_COMPLETO": "sample string 3",
        "NM_SOCIAL_COMPLETO": "sample string 4",
        "NR_ANO_OBITO": "sample string 5",
        "NR_CPF": 1,
        "NR_IDADE": 1,
        "ERRO": {
          "CODIGO": 1,
          "MENSAGEM": "sample string 2"
        }
      },
      "ERRO": {
        "CODIGO": 1,
        "MENSAGEM": "sample string 2"
      }
    },
    {
      "DADOS_PRINCIPAIS": {
        "DS_SEXO": "sample string 1",
        "DS_SIGNO": "sample string 2",
        "DT_NASCIMENTO": "2024-06-30T04:38:06.5891625-03:00",
        "DT_RECENCIA": "2024-06-30T04:38:06.5891625-03:00",
        "FG_OBITO": true,
        "NM_COMPLETO": "sample string 3",
        "NM_SOCIAL_COMPLETO": "sample string 4",
        "NR_ANO_OBITO": "sample string 5",
        "NR_CPF": 1,
        "NR_IDADE": 1,
        "ERRO": {
          "CODIGO": 1,
          "MENSAGEM": "sample string 2"
        }
      },
      "ERRO": {
        "CODIGO": 1,
        "MENSAGEM": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<ResultadoListaPessoaEmail 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_EMAIL>
      <ERRO>
        <CODIGO>1</CODIGO>
        <MENSAGEM>sample string 2</MENSAGEM>
      </ERRO>
      <DADOS_PRINCIPAIS>
        <ERRO>
          <CODIGO>1</CODIGO>
          <MENSAGEM>sample string 2</MENSAGEM>
        </ERRO>
        <DS_SEXO>sample string 1</DS_SEXO>
        <DS_SIGNO>sample string 2</DS_SIGNO>
        <DT_NASCIMENTO>2024-06-30T04:38:06.5891625-03:00</DT_NASCIMENTO>
        <DT_RECENCIA>2024-06-30T04:38:06.5891625-03:00</DT_RECENCIA>
        <FG_OBITO>true</FG_OBITO>
        <NM_COMPLETO>sample string 3</NM_COMPLETO>
        <NM_SOCIAL_COMPLETO>sample string 4</NM_SOCIAL_COMPLETO>
        <NR_ANO_OBITO>sample string 5</NR_ANO_OBITO>
        <NR_CPF>1</NR_CPF>
        <NR_IDADE>1</NR_IDADE>
      </DADOS_PRINCIPAIS>
    </PESSOA_EMAIL>
    <PESSOA_EMAIL>
      <ERRO>
        <CODIGO>1</CODIGO>
        <MENSAGEM>sample string 2</MENSAGEM>
      </ERRO>
      <DADOS_PRINCIPAIS>
        <ERRO>
          <CODIGO>1</CODIGO>
          <MENSAGEM>sample string 2</MENSAGEM>
        </ERRO>
        <DS_SEXO>sample string 1</DS_SEXO>
        <DS_SIGNO>sample string 2</DS_SIGNO>
        <DT_NASCIMENTO>2024-06-30T04:38:06.5891625-03:00</DT_NASCIMENTO>
        <DT_RECENCIA>2024-06-30T04:38:06.5891625-03:00</DT_RECENCIA>
        <FG_OBITO>true</FG_OBITO>
        <NM_COMPLETO>sample string 3</NM_COMPLETO>
        <NM_SOCIAL_COMPLETO>sample string 4</NM_SOCIAL_COMPLETO>
        <NR_ANO_OBITO>sample string 5</NR_ANO_OBITO>
        <NR_CPF>1</NR_CPF>
        <NR_IDADE>1</NR_IDADE>
      </DADOS_PRINCIPAIS>
    </PESSOA_EMAIL>
  </PESSOAS>
</ResultadoListaPessoaEmail>