GET/identity

Encontrar por item

Recupera a identidade de um item, se disponível

Parameters

Query Parameters

Name	Type	Description
`itemId`required	string (uuid)	Identificador principal do Item

Responses

200Recuperar uma identidade pelo itemId

object

Response with details personal information related to the owner of the connection's account

idrequiredstring

A ID da identidade a ser recuperada

itemIdrequiredstring (uuid)

Identificador do item vinculado à identidade

birthDatestring (date-time) | null

Data de nascimento

taxNumberstring | null

O CPF/CNPJ associado à conta empresarial

documentstring | null

Documento principal que identifica o proprietário

documentTypestring | null

Tipo de documento coletado

jobTitlestring | null

Informações sobre profissão ou trabalho

fullNamestring | null

Nome do titular da conta

establishmentCodestring | null

Código de estabelecimento (apenas para conectores PAYMENT_ACCOUNT)

establishmentNamestring | null

Nome do estabelecimento (somente para conectores PAYMENT_ACCOUNT)

companyNamestring | null

Para o conector de negócios, o nome da empresa

phoneNumbersobject[] | null

Lista de números de telefone relacionados à conta

itemsobject

The phone number object contains data related to contact information.

emailsobject[] | null

Lista de endereços de e-mail relacionados à conta

itemsobject

The email object contains emails associated with the owner of the account

addressesobject[] | null

Lista de endereços relacionados à conta

itemsobject

The address object contains data related to an specific owner's location.

relationsobject[] | null

Lista de nomes relacionados à conta

itemsobject

The relation object contains name and relation to the owner of the account

investorProfilestring | null

É uma classificação que indica a personalidade do investidor e a motivação para investir.

ConservativeModerateAggressivenull

qualificationsobject | null

Informações que permitem entender desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que atualmente consome e seus representantes.

companyCnpjrequiredstring

CNPJ of the company

occupationCodestring

Occupation code

RECEITA_FEDERALCBOOUTRO

occupationDescriptionstring

Free-text occupation description. When occupationCode is RECEITA_FEDERAL or CBO it holds the standardized list code; when OUTRO it describes the occupation in cases where the institution does not follow the Receita Federal nor the CBO list

informedIncomeobject

Informed income

informedPatrimonyobject

Informed patrimony

economicActivitiesobject[]

List of CNAE codes describing the economic activities of the business (Brazilian National Classification of Economic Activities). Only one entry per response should be marked as main

informedRevenueobject

Revenue (faturamento) informed by the business — the business equivalent of informedIncome

financialRelationshipsobject | null

Informações que permitem às instituições avaliar, caracterizar e classificar o cliente com o propósito de entender seu perfil de risco e sua capacidade econômico-financeira.

startDaterequiredstring (date-time)

Date when the relationship with the institution started

productsServicesTyperequiredstring[]

List of products and services that the client consumes

productsServicesTypeAdditionalInfostring

Additional info about the products and services. Populated when productsServicesType includes 'OUTROS'

procuratorsrequiredobject[]

List of procurators of the client

accountsobject[]

List of accounts of the client with valid consent. Only accounts that have explicit user consent are returned.

portabilitiesReceivedobject[]

Salary portabilities received by the institution from the client's previous paycheck banks (banco-folha). PF-only field

paychecksBankLinkobject[]

Paycheck-bank (banco-folha) links to employers, active or formerly active. PF-only field

socialNamestring | null

Nome social da pessoa natural, se houver (o nome pelo qual travestis e transexuais se reconhecem e são reconhecidos em sua comunidade). Campo exclusivo para PF

sexstring | null

Sexo da pessoa física. Campo exclusivo para PF

FEMALEMALEOTHERnull

maritalStatusobject | null

Estado civil da pessoa física. Campo exclusivo para PF

Any of:

option 1object

Marital status of the natural person

option 2null | null

nationalityobject | null

Nacionalidade da pessoa física. Campo exclusivo para PF

Any of:

option 1object

Nationality of the natural person

option 2null | null

otherDocumentsobject[] | null

Lista de outros documentos de identificação que a pessoa natural possui. Campo exclusivo para PF

itemsobject

Other identification document held by the natural person. Brazilian acronyms are kept verbatim; OTHER covers any other type

passportobject | null

Metadados do passaporte para a pessoa física. Campo exclusivo para PF

Any of:

option 1object

Passport metadata for the natural person. Applies when the client is a non-resident not required to register a CPF

option 2null | null

incorporationDatestring (date-time) | null

Data em que a empresa foi incorporada. Campo apenas para PJ

partiesobject[] | null

Parceiros e administradores da empresa. Campo apenas para PJ

itemsobject

Partner or administrator of a business. Partners with less than 25% shareholding may be omitted by the institution

businessOtherDocumentsobject[] | null

Lista de documentos adicionais para empresas com sede no exterior e que não são obrigadas a registrar um CNPJ. Campo apenas para PJ

itemsobject

Additional document for businesses headquartered abroad and not required to register a CNPJ

companiesCnpjstring[] | null

CNPJs das instituições financeiras responsáveis pelo cadastro do cliente. Números apenas, sem máscara

itemsstring

createdAtstring (date-time)

Data em que a identidade foi inicialmente capturada pelo Pluggy.

updatedAtstring (date-time)

Data da última atualização dos dados de identidade.

Example response

json

{
  "id": "42888436-62f5-49d2-8cf9-e312c7939509",
  "itemId": "a0d4d1b0-1d1e-4f1a-9a1e-0f1c2d3e4f5a",
  "fullName": "Francisco Sousa",
  "companyName": "Pluggy Inc.",
  "document": "076.630.975-48",
  "taxNumber": "38.512.121/0001-95",
  "documentType": "CPF",
  "jobTitle": "Comercial",
  "birthDate": "1991-05-01T00:00:00.000Z",
  "establishmentCode": "001",
  "establishmentName": "Pluggy Establishment",
  "addresses": [
    {
      "fullAddress": "Av. Lúcio Costa 1234, Copacabana, Rio de Janeiro, Brasil",
      "country": "Brasil",
      "state": "RJ",
      "city": "Rio de Janeiro",
      "postalCode": "22620-171",
      "primaryAddress": "Av. Lúcio Costa, 1234",
      "type": "Personal",
      "additionalInfo": "Apartamento 101"
    }
  ],
  "phoneNumbers": [
    {
      "type": "Personal",
      "value": "+54 911 12345678"
    }
  ],
  "emails": [
    {
      "type": "Personal",
      "value": "myemail@example.com"
    }
  ],
  "relations": [
    {
      "type": "Father",
      "name": "Juan Gonzalez"
    },
    {
      "type": "Spouse",
      "name": "Laura Garcia"
    }
  ],
  "createdAt": "2020-09-30T14:38:12.724Z",
  "updatedAt": "2020-09-30T14:38:12.724Z"
}

curl -X GET \
  'https://api.pluggy.ai/identity' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "id": "42888436-62f5-49d2-8cf9-e312c7939509",
  "itemId": "a0d4d1b0-1d1e-4f1a-9a1e-0f1c2d3e4f5a",
  "fullName": "Francisco Sousa",
  "companyName": "Pluggy Inc.",
  "document": "076.630.975-48",
  "taxNumber": "38.512.121/0001-95",
  "documentType": "CPF",
  "jobTitle": "Comercial",
  "birthDate": "1991-05-01T00:00:00.000Z",
  "establishmentCode": "001",
  "establishmentName": "Pluggy Establishment",
  "addresses": [
    {
      "fullAddress": "Av. Lúcio Costa 1234, Copacabana, Rio de Janeiro, Brasil",
      "country": "Brasil",
      "state": "RJ",
      "city": "Rio de Janeiro",
      "postalCode": "22620-171",
      "primaryAddress": "Av. Lúcio Costa, 1234",
      "type": "Personal",
      "additionalInfo": "Apartamento 101"
    }
  ],
  "phoneNumbers": [
    {
      "type": "Personal",
      "value": "+54 911 12345678"
    }
  ],
  "emails": [
    {
      "type": "Personal",
      "value": "myemail@example.com"
    }
  ],
  "relations": [
    {
      "type": "Father",
      "name": "Juan Gonzalez"
    },
    {
      "type": "Spouse",
      "name": "Laura Garcia"
    }
  ],
  "createdAt": "2020-09-30T14:38:12.724Z",
  "updatedAt": "2020-09-30T14:38:12.724Z"
}