Identidade

A entidade Identidade é recuperada de instituições que suportam este produto, acessando detalhes de informações pessoais relacionadas ao proprietário da conta da conexão. Recuperar este produto ajuda você a verificar as identidades dos usuários.

Campos de Open Finance

Para conectores de Open Finance, campos adicionais estão disponíveis, incluindo investorProfile, qualifications, financialRelationships, além de um conjunto mais rico de atributos PF (pessoa física) e PJ (pessoa jurídica) — socialName, sex, maritalStatus, nationality, otherDocuments, passport, incorporationDate, parties, businessOtherDocuments e companiesCnpj. Esses campos fornecem dados de clientes aprimorados para contas consentidas.

{
  "id": "42888436-62f5-49d2-8cf9-e312c7939509",
  "fullName": "Francisco Sousa",
  "companyName": "Pluggy Inc.",
  "document": "123.456.789-00",
  "taxNumber": "33.333.333/0001-33",
  "documentType": "CPF",
  "jobTitle": "Comercial",
  "birthDate": "1991-05-01T00:00:00.000Z",
  "investorProfile": "Moderate",
  "establishmentCode": "001",
  "establishmentName": "Pluggy Establishment",
  "addresses": [
    {
      "fullAddress": "Av. Lucio Costa 1234, Copacabana, Rio de Janeiro, Brasil",
      "country": "Brasil",
      "state": "RJ",
      "city": "Rio de Janeiro",
      "additionalInfo": "Casa amarela",
      "postalCode": "22620-171",
      "primaryAddress": "Av. Lucio Costa, 1234",
      "type": "Personal"
    }
  ],
  "phoneNumbers": [
    {
      "type": "Personal",
      "value": "+54 911 12345678"
    }
  ],
  "emails": [
    {
      "type": "Personal",
      "value": "hello@pluggy.ai"
    }
  ],
  "relations": [
    {
      "type": "CONJUGE",
      "name": "Maria Sousa",
      "document": "098.765.432-10"
    }
  ]
}

Para conectores de Open Finance, a entidade Identidade carrega o conjunto de campos PF/PJ estendido:

Open Finance

{
  "id": "42888436-62f5-49d2-8cf9-e312c7939509",
  "itemId": "9b59ab4b-2480-4dfc-9a0d-99b964ba578d",
  "fullName": "Henrique Alexsander Eichstädt",
  "socialName": "Henrique",
  "companyName": "Tech Solutions LTDA",
  "document": "12345678900",
  "taxNumber": "33.333.333/0001-33",
  "documentType": "CPF",
  "jobTitle": "CEO",
  "birthDate": "1985-03-15T00:00:00.000Z",
  "sex": "MALE",
  "maritalStatus": {
    "code": "MARRIED"
  },
  "nationality": {
    "hasBrazilianNationality": true
  },
  "otherDocuments": [
    {
      "type": "CNH",
      "number": "12345678900",
      "checkDigit": "P",
      "additionalInfo": "SSP/SP",
      "expirationDate": "2030-05-21T00:00:00.000Z"
    }
  ],
  "incorporationDate": "2010-01-01T00:00:00.000Z",
  "parties": [
    {
      "type": "PARTNER",
      "personType": "NATURAL_PERSON",
      "documentType": "CPF",
      "documentNumber": "12345678900",
      "civilName": "Henrique Alexsander Eichstädt",
      "startDate": "2010-01-01T00:00:00.000Z",
      "shareholding": 0.51
    }
  ],
  "companiesCnpj": ["33333333000133"],
  "addresses": [
    {
      "fullAddress": "Av. Paulista 1234, Bela Vista, 01310-100, São Paulo, Brasil",
      "country": "Brasil",
      "countryCode": "BRA",
      "state": "SP",
      "city": "São Paulo",
      "district": "Bela Vista",
      "ibgeTownCode": "3550308",
      "postalCode": "01310-100",
      "primaryAddress": "Av. Paulista, 1234",
      "type": "Work",
      "additionalInfo": "Sala 501",
      "geographicCoordinates": {
        "latitude": -23.5614,
        "longitude": -46.6559
      }
    }
  ],
  "phoneNumbers": [
    {
      "type": "Work",
      "value": "+55 (11) 987654321",
      "countryCallingCode": "55",
      "areaCode": "11",
      "extension": "501"
    }
  ],
  "emails": [
    {
      "type": "Work",
      "value": "henrique@techsolutions.com.br"
    }
  ],
  "relations": [],
  "investorProfile": "Moderate",
  "qualifications": {
    "companyCnpj": "33333333000133",
    "occupationCode": "CBO",
    "occupationDescription": "1234-5",
    "informedIncome": {
      "frequency": "ANUAL",
      "amount": 250000,
      "date": "2024-01-01T00:00:00.000Z"
    },
    "informedPatrimony": {
      "amount": 1500000,
      "year": 2024,
      "date": "2024-12-31T00:00:00.000Z"
    },
    "economicActivities": [
      {
        "code": "6201501",
        "isMain": true
      }
    ],
    "informedRevenue": {
      "amount": 500000,
      "frequency": "MONTHLY",
      "year": 2024
    }
  },
  "financialRelationships": {
    "startDate": "2020-05-10T00:00:00.000Z",
    "productsServicesType": [
      "CONTA_DEPOSITO_A_VISTA",
      "CONTA_POUPANCA",
      "OPERACAO_CREDITO"
    ],
    "procurators": [
      {
        "type": "PROCURADOR",
        "cpfNumber": "45678912303",
        "documentNumber": "45678912303",
        "documentType": "CPF",
        "civilName": "Roberto Carlos Mendes Silva",
        "socialName": "Roberto"
      }
    ],
    "accounts": [
      {
        "compeCode": "237",
        "branchCode": "0001",
        "number": "123456",
        "checkDigit": "7",
        "type": "CONTA_DEPOSITO_A_VISTA",
        "subtype": "INDIVIDUAL"
      }
    ],
    "portabilitiesReceived": [
      {
        "employerName": "Acme Inc",
        "employerDocument": "60701190000104",
        "paycheckBankDetainerCnpj": "60701190000204",
        "paycheckBankDetainerIspb": "60701190",
        "portabilityApprovalDate": "2021-03-15T00:00:00.000Z"
      }
    ],
    "paychecksBankLink": [
      {
        "employerName": "Acme Inc",
        "employerDocument": "60701190000104",
        "paycheckBankCnpj": "60701190000204",
        "paycheckBankIspb": "60701190",
        "accountOpeningDate": "2020-01-10T00:00:00.000Z"
      }
    ]
  },
  "createdAt": "2020-09-30T14:38:12.724Z",
  "updatedAt": "2024-12-12T10:30:00.000Z"
}

Propriedade	Tipo	Opcional	Descrição
id	string	Não	Identificador primário.
fullName	string	Não	Nome completo do proprietário da conta.
companyName	string	Sim	Nome da empresa (para contas de negócios).
document	string	Não	Número do documento (CPF ou CNPJ).
taxNumber	string	Sim	Número de identificação fiscal.
documentType	string	Não	Tipo do documento (CPF, CNPJ).
jobTitle	string	Sim	Cargo do proprietário da conta.
birthDate	string	Sim	Data de nascimento.
investorProfile	string	Sim	Classificação do perfil do investidor (por exemplo, Conservador, Moderado, Agressivo). Disponível apenas para conectores de Open Finance.
establishmentCode	string	Sim	Código do estabelecimento.
establishmentName	string	Sim	Nome do estabelecimento.
addresses	array	Sim	Lista de endereços associados à identidade.
phoneNumbers	array	Sim	Lista de números de telefone.
emails	array	Sim	Lista de endereços de e-mail.
relations	array	Sim	Lista de pessoas relacionadas (por exemplo, cônjuge).
socialName	string	Sim	Nome social da pessoa física, se houver (apenas PF, Open Finance).
sex	string	Sim	Sexo da pessoa física — `FEMALE`, `MALE` ou `OTHER` (apenas PF, Open Finance).
maritalStatus	MaritalStatus	Sim	Estado civil da pessoa física (apenas PF, Open Finance).
nationality	Nationality	Sim	Nacionalidade da pessoa física (apenas PF, Open Finance).
otherDocuments	array of OtherDocument	Sim	Lista de outros documentos de identificação que a pessoa física possui — CNH, RG, NIF, RNE ou OUTRO (apenas PF, Open Finance).
passport	Passport	Sim	Metadados do passaporte — aplica-se quando a pessoa física é um não-residente que não precisa registrar um CPF (apenas PF, Open Finance).
incorporationDate	Date	Sim	Data em que a empresa foi incorporada (apenas PJ, Open Finance).
parties	array of BusinessParty	Sim	Sócios e administradores da empresa (apenas PJ, Open Finance).
businessOtherDocuments	array of BusinessOtherDocument	Sim	Documentos adicionais para empresas com sede no exterior e que não precisam registrar um CNPJ (apenas PJ, Open Finance).
companiesCnpj	array of string	Sim	CNPJs das instituições financeiras responsáveis pelo cadastro do cliente (Open Finance, PF e PJ).
qualifications	Qualifications	Sim	Dados de qualificações do cliente. Disponível apenas para conectores de Open Finance.
financialRelationships	FinancialRelationships	Sim	Relacionamento do cliente com a instituição. Disponível apenas para conectores de Open Finance.

Endereço #

Propriedade	Tipo	Opcional	Descrição
fullAddress	string	Sim	String de endereço completo.
country	string	Sim	Nome do país.
countryCode	string	Sim	Código do país no formato alpha3 ISO-3166 (por exemplo, `BRA`). Apenas Open Finance.
state	string	Sim	Código do estado.
city	string	Sim	Nome da cidade.
district	string	Sim	Bairro. Apenas Open Finance.
ibgeTownCode	string	Sim	Código do município IBGE (7 dígitos). Os dois primeiros dígitos identificam a Unidade da Federação. Apenas Open Finance.
additionalInfo	string	Sim	Informações adicionais sobre o endereço.
postalCode	string	Sim	Código postal/ZIP.
primaryAddress	string	Sim	Endereço principal.
type	string	Sim	Tipo de endereço (Pessoal, Trabalho).
geographicCoordinates	object	Sim	Coordenadas geográficas em graus decimais, sistema de referência WGS84. Objeto com `latitude` e `longitude`. Apenas Open Finance.

Número de Telefone #

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	Tipo de número de telefone (Pessoal, Trabalho ou Residencial).
value	string	Sim	Valor do número de telefone.
countryCallingCode	string	Sim	Código de discagem internacional (DDI). Preenchido quando diferente de `55`. Apenas Open Finance.
areaCode	string	Sim	Código de área (DDD) do telefone. Apenas Open Finance.
extension	string	Sim	Número da extensão, quando parte da identificação do telefone. Apenas Open Finance.
additionalInfo	string	Sim	Informações adicionais sobre o telefone, por exemplo, quando o tipo de origem não se encaixa nas categorias padrão. Apenas Open Finance.

E-mail #

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	Tipo de e-mail (Pessoal, Negócios).
value	string	Sim	Valor do endereço de e-mail.

Relação #

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	Tipo de relação (por exemplo, CONJUGE, PROCURADOR).
name	string	Sim	Nome da pessoa relacionada.
document	string	Sim	Número do documento da pessoa relacionada.

MaritalStatus #

Estado civil da pessoa física (apenas PF, Open Finance).

{
  "code": "MARRIED",
  "additionalInfo": "União civil"
}

Propriedade	Tipo	Opcional	Descrição
code	string	Sim	`SINGLE`, `MARRIED`, `WIDOWED`, `JUDICIALLY_SEPARATED`, `DIVORCED`, `STABLE_UNION` ou `OTHER`.
additionalInfo	string	Sim	Complemento em texto livre. Deve ser definido quando `code` for `OTHER`.

Nacionalidade #

Nacionalidade da pessoa física (apenas PF, Open Finance).

{
  "hasBrazilianNationality": false,
  "otherNationalities": [
    {
      "countryCode": "ITA",
      "documents": [
        {
          "type": "Passport",
          "number": "YA1234567",
          "country": "ITA",
          "issueDate": "2020-05-30T00:00:00.000Z",
          "expirationDate": "2030-05-30T00:00:00.000Z"
        }
      ]
    }
  ]
}

Propriedade	Tipo	Opcional	Descrição
hasBrazilianNationality	boolean	Sim	Se o cliente possui nacionalidade brasileira.
otherNationalities	array	Sim	Outras nacionalidades que o cliente possui, se houver.

Cada entrada otherNationalities[]:

Propriedade	Tipo	Opcional	Descrição
countryCode	string	Sim	Código do país no formato alpha3 ISO-3166.
documents	array	Sim	Documentos de apoio para esta nacionalidade. Veja `NationalityDocument` abaixo.

Cada entrada documents[] (NationalityDocument):

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	Tipo de documento (texto livre). Obrigatório quando a nacionalidade não é brasileira.
number	string	Sim	Número do documento. Obrigatório quando a nacionalidade não é brasileira.
country	string	Sim	Nome do país.
issueDate	Date	Sim	Data de emissão do documento.
expirationDate	Date	Sim	Data de expiração do documento.
additionalInfo	string	Sim	Complemento em texto livre.

OtherDocument #

Outros documentos de identificação que a pessoa física possui (apenas PF, Open Finance). As siglas brasileiras são mantidas verbatim; OTHER cobre qualquer outro tipo.

{
  "type": "CNH",
  "number": "12345678900",
  "checkDigit": "P",
  "additionalInfo": "SSP/SP",
  "expirationDate": "2030-05-21T00:00:00.000Z"
}

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	`CNH`, `RG`, `NIF`, `RNE` ou `OTHER`.
typeAdditionalInfo	string	Sim	Complemento em texto livre. Deve ser definido quando `type` for `OTHER`.
number	string	Sim	Número do documento.
checkDigit	string	Sim	Dígito de verificação do documento, se houver.
additionalInfo	string	Sim	Complemento em texto livre, usado para registrar a autoridade emissora (por exemplo, `SSP/SP`) quando relevante.
expirationDate	Date	Sim	Data de expiração do documento.

Passaporte #

Metadados do passaporte para a pessoa física (apenas PF, Open Finance). Aplica-se quando o cliente é um não-residente que não precisa registrar um CPF.

{
  "number": "YA1234567",
  "country": "ITA",
  "issueDate": "2020-05-30T00:00:00.000Z",
  "expirationDate": "2030-05-30T00:00:00.000Z"
}

Propriedade	Tipo	Opcional	Descrição
number	string	Sim	Número do passaporte.
country	string	Sim	País emissor no formato alpha3 ISO-3166.
issueDate	Date	Sim	Data de emissão do passaporte.
expirationDate	Date	Sim	Data de expiração do passaporte.

BusinessParty #

Sócio ou administrador de uma empresa (apenas PJ, Open Finance). Sócios com menos de 25% de participação podem ser omitidos pela instituição.

{
  "type": "PARTNER",
  "personType": "NATURAL_PERSON",
  "documentType": "CPF",
  "documentNumber": "12345678900",
  "civilName": "Henrique Alexsander Eichstädt",
  "startDate": "2010-01-01T00:00:00.000Z",
  "shareholding": 0.51
}

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	`PARTNER` (sócio) ou `ADMINISTRATOR` (administrador).
personType	string	Sim	`NATURAL_PERSON` ou `LEGAL_ENTITY`.
documentType	string	Sim	`CPF`, `CNPJ`, `PASSPORT` ou `OTHER_TRAVEL_DOCUMENT`.
documentNumber	string	Sim	Número do documento de identificação (dígitos e dígito de verificação, se houver).
documentCountry	string	Sim	País emissor do documento, alpha3 ISO-3166.
documentExpirationDate	Date	Sim	Data de expiração do documento.
documentIssueDate	Date	Sim	Data de emissão do documento.
documentAdditionalInfo	string	Sim	Complemento em texto livre quando o documento contém informações de identificação que não se encaixam nos outros campos.
civilName	string	Sim	Nome civil da parte. Obrigatório quando `personType` é `NATURAL_PERSON`.
socialName	string	Sim	Nome social da parte pessoa física, se houver.
companyName	string	Sim	Nome da empresa da parte. Obrigatório quando `personType` é `LEGAL_ENTITY`.
tradeName	string	Sim	Nome comercial da parte pessoa jurídica, se houver.
startDate	Date	Sim	Data em que a participação da parte começou.
shareholding	number	Sim	Fração de participação entre 0 e 1 (por exemplo, `0.51` representa 51%, `1` representa 100%). Obrigatório quando `type` é `PARTNER` e a participação é de 25% ou mais.

BusinessOtherDocument #

Documento adicional para empresas com sede no exterior e que não precisam registrar um CNPJ (apenas PJ, Open Finance).

{
  "type": "EIN",
  "number": "128328453",
  "country": "USA",
  "expirationDate": "2030-05-21T00:00:00.000Z"
}

Propriedade	Tipo	Opcional	Descrição
type	string	Sim	Tipo do documento (por exemplo, `EIN`).
number	string	Sim	Número do documento.
country	string	Sim	País emissor no formato alpha3 ISO-3166.
expirationDate	Date	Sim	Data de expiração do documento.

Qualifications #

Dados de qualificações do cliente (Open Finance).

{
  "companyCnpj": "33333333000133",
  "occupationCode": "CBO",
  "occupationDescription": "1234-5",
  "informedIncome": {
    "frequency": "ANUAL",
    "amount": 250000,
    "date": "2024-01-01T00:00:00.000Z"
  },
  "informedPatrimony": {
    "amount": 1500000,
    "year": 2024,
    "date": "2024-12-31T00:00:00.000Z"
  },
  "economicActivities": [
    {
      "code": "6201501",
      "isMain": true
    }
  ],
  "informedRevenue": {
    "amount": 500000,
    "frequency": "MONTHLY",
    "year": 2024
  }
}

Propriedade	Tipo	Opcional	Descrição
companyCnpj	string	Sim	CNPJ da empresa associada às qualificações.
occupationCode	string	Sim	`RECEITA_FEDERAL`, `CBO` ou `OUTRO`.
occupationDescription	string	Sim	Descrição da ocupação em texto livre. Contém o código da lista padronizada quando `occupationCode` é `RECEITA_FEDERAL` ou `CBO`; a descrição personalizada quando `OUTRO`.
informedIncome	object	Sim	Renda informada. Objeto com `frequency` (`DIARIA`, `SEMANAL`, `QUINZENAL`, `MENSAL`, `BIMESTRAL`, `TRIMESTRAL`, `SEMESTRAL`, `ANUAL`, `OUTROS`), `amount` e `date`.
informedPatrimony	object	Sim	Patrimônio informado. Objeto com `amount`, `year` e opcionalmente `date` (retornado no caminho de negócios PJ).
economicActivities	array	Sim	Códigos CNAE descrevendo as atividades econômicas da empresa (apenas PJ). Cada entrada tem `code` (CNAE de 7 dígitos) e `isMain` booleano.
informedRevenue	object	Sim	Receita (faturamento) informada pela empresa — o equivalente empresarial de `informedIncome` (apenas PJ). Objeto com `amount`, `frequency` opcional (`DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `BIMONTHLY`, `QUARTERLY`, `SEMIANNUAL`, `ANNUAL`, `OTHER`), `frequencyAdditionalInfo` e `year`.

FinancialRelationships #

Relacionamento do cliente com a instituição (Open Finance).

{
  "startDate": "2020-05-10T00:00:00.000Z",
  "productsServicesType": ["CONTA_DEPOSITO_A_VISTA", "OPERACAO_CREDITO"],
  "procurators": [
    {
      "type": "PROCURADOR",
      "cpfNumber": "45678912303",
      "documentNumber": "45678912303",
      "documentType": "CPF",
      "civilName": "Roberto Carlos Mendes Silva",
      "socialName": "Roberto"
    }
  ],
  "accounts": [
    {
      "compeCode": "237",
      "branchCode": "0001",
      "number": "123456",
      "checkDigit": "7",
      "type": "CONTA_DEPOSITO_A_VISTA",
      "subtype": "INDIVIDUAL"
    }
  ],
  "portabilitiesReceived": [
    {
      "employerName": "Acme Inc",
      "employerDocument": "60701190000104",
      "paycheckBankDetainerCnpj": "60701190000204",
      "paycheckBankDetainerIspb": "60701190",
      "portabilityApprovalDate": "2021-03-15T00:00:00.000Z"
    }
  ],
  "paychecksBankLink": [
    {
      "employerName": "Acme Inc",
      "employerDocument": "60701190000104",
      "paycheckBankCnpj": "60701190000204",
      "paycheckBankIspb": "60701190",
      "accountOpeningDate": "2020-01-10T00:00:00.000Z"
    }
  ]
}

Propriedade	Tipo	Opcional	Descrição
startDate	Date	Sim	Data em que o relacionamento com a instituição começou.
productsServicesType	array of string	Sim	Lista de produtos e serviços que o cliente consome (por exemplo, `CONTA_DEPOSITO_A_VISTA`, `CARTAO_CREDITO`, `OPERACAO_CREDITO`).
productsServicesTypeAdditionalInfo	string	Sim	Informações adicionais sobre os produtos e serviços. Preenchido quando `productsServicesType` inclui `OUTROS`.
procurators	array	Sim	Lista de procuradores. Cada entrada tem `type` (`REPRESENTANTE_LEGAL` ou `PROCURADOR`), `cpfNumber` (legado — pode conter um CNPJ em PJ), o par canônico `documentNumber` + `documentType` (`CPF` / `CNPJ`), `civilName` e opcionalmente `socialName`.
accounts	array	Sim	Lista de contas consentidas. Cada entrada tem `compeCode`, `branchCode`, `number`, `checkDigit`, `type` (`CONTA_DEPOSITO_A_VISTA`, `CONTA_POUPANCA`, `CONTA_PAGAMENTO_PRE_PAGA`) e `subtype` (`INDIVIDUAL`, `CONJUNTA_SIMPLES`, `CONJUNTA_SOLIDARIA`).
portabilitiesReceived	array	Sim	Portabilidades de salário recebidas pela instituição dos bancos de folha de pagamento anteriores do cliente (banco-folha). Apenas PF. Veja o esquema de entrada abaixo.
paychecksBankLink	array	Sim	Links de banco de folha de pagamento (banco-folha) para empregadores, ativos ou anteriormente ativos. Apenas PF. Veja o esquema de entrada abaixo.

Cada entrada portabilitiesReceived[]:

Propriedade	Tipo	Opcional	Descrição
employerName	string	Sim	Nome do empregador conforme recebido na mensagem de portabilidade.
employerDocument	string	Sim	Documento do empregador (CPF ou CNPJ) conforme recebido na mensagem de portabilidade.
paycheckBankDetainerCnpj	string	Sim	CNPJ do banco que detém a conta de pagamento (banco-folha).
paycheckBankDetainerIspb	string	Sim	ISPB do banco que detém a conta de pagamento.
portabilityApprovalDate	Date	Sim	Data em que a portabilidade foi aprovada.

Cada entrada paychecksBankLink[]:

Propriedade	Tipo	Opcional	Descrição
employerName	string	Sim	Nome do empregador conforme registrado quando a conta de pagamento foi aberta.
employerDocument	string	Sim	Documento do empregador (CPF ou CNPJ) conforme registrado quando a conta de pagamento foi aberta.
paycheckBankCnpj	string	Sim	CNPJ da instituição contratada para fornecer o serviço de pagamento (banco-folha).
paycheckBankIspb	string	Sim	ISPB da instituição contratada para fornecer o serviço de pagamento.
accountOpeningDate	Date	Sim	Data em que a conta de pagamento foi aberta.

Veja IdentidadeAPI em nossa referência da API para mais informações.