Relacionamentos

Pessoas Relacionadas (PF39)

Retorna o nome e o relacionamento de pessoas possivelmente relacionadas a esta pessoa.

Seção: pfPersonalRelationships

Parâmetro obrigatório: cpf

Esquema

Atributo	Tipo	Descrição
statusCode	String	Status da consulta (detalhes)
data	Array	Dados de retorno
data[x].relatedEntityTaxIdNumber	String	Número do documento de identificação
data[x].relatedEntityTaxIdType	String	Tipo de documento de identificação
data[x].relatedEntityName	String	Nome da pessoa relacionada
data[x].relationshipType	String	Tipo de relacionamento
data[x].relationshipLevel	String	Nível do relacionamento

Exemplo

{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "relatedEntityTaxIdNumber": "",
        "relatedEntityTaxIdType": "CPF",
        "relatedEntityName": "MARIA DOE",
        "relationshipType": "MÃE",
        "relationshipLevel": "DIRETO"
      },
      {
        "relatedEntityTaxIdNumber": "01XXXXXXX16",
        "relatedEntityTaxIdType": "CPF",
        "relatedEntityName": "GABRIEL DOE",
        "relationshipType": "IRMÃO",
        "relationshipLevel": "DIRETO"
      }
    ]
  }
}

Números de telefone de pessoas relacionadas (PF38)

Retorna o número de telefone e o relacionamento de pessoas possivelmente relacionadas a esta pessoa.

Seção: pfRelatedPeoplePhones

Parâmetro obrigatório: cpf

Esquema

Atributo	Tipo	Descrição
statusCode	String	Status da consulta (detalhes)
data	Array	Dados de retorno
data[x].number	String	Número de telefone
data[x].areaCode	String	Código de área
data[x].countryCode	String	Código do país
data[x].type	String	Tipo
data[x].lastPassageDate	String	Data da última validação
data[x].portabilityHistory	Array	Histórico de portabilidade
data[x].hasOptIn	Booleano	Aceita ligações de marketing

Exemplo

{
  "statusCode": "01",
  "data": [
    {
      "number": "22112200",
      "areaCode": "54",
      "countryCode": "55",
      "type": "RELATED - 01XXXXXXX16 - IRMÃO - TRABALHO",
      "lastPassageDate": "2016-02-01T00:00:00Z",
      "portabilityHistory": [],
      "hasOptIn": false
    }
  ]
}