Identity

The Identity entity is recovered from institutions that support this product, accessing details of personal information related to the owner of the connection's account. Recovering this product helps you verify users' identities.

📘
Open Finance Fields
For Open Finance connectors, additional fields are available including investorProfile, qualifications, financialRelationships, plus a richer set of PF (natural person) and PJ (business) attributes — socialName, sex, maritalStatus, nationality, otherDocuments, passport, incorporationDate, parties, businessOtherDocuments, and companiesCnpj. These fields provide enhanced customer data for consented accounts.

{
  "id": "42888436-62f5-49d2-8cf9-e312c7939509",
  "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",
  "investorProfile": "Moderate",
  "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",
      "additionalInfo": "Casa amarela",
      "postalCode": "22620-171",
      "primaryAddress": "Av. Lúcio Costa, 1234",
      "type": "Personal"
    }
  ],
  "phoneNumbers": [
    {
      "type": "Personal",
      "value": "+54 911 12345678"
    }
  ],
  "emails": [
    {
      "type": "Personal",
      "value": "[email protected]"
    }
  ],
  "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"
}

{
  "id": "42888436-62f5-49d2-8cf9-e312c7939509",
  "itemId": "9b59ab4b-2480-4dfc-9a0d-99b964ba578d",
  "fullName": "Henrique Alexsander Eichstädt",
  "socialName": "Henrique",
  "companyName": "Tech Solutions LTDA",
  "document": "08206234900",
  "taxNumber": "38.512.121/0001-95",
  "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": "08206234900",
      "civilName": "Henrique Alexsander Eichstädt",
      "startDate": "2010-01-01T00:00:00.000Z",
      "shareholding": 0.51
    }
  ],
  "companiesCnpj": ["38512121000195"],
  "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": "[email protected]"
    }
  ],
  "relations": [],
  "investorProfile": "Moderate",
  "qualifications": {
    "companyCnpj": "38512121000195",
    "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"
      },
      {
        "type": "REPRESENTANTE_LEGAL",
        "cpfNumber": "78934521067",
        "documentNumber": "78934521067",
        "documentType": "CPF",
        "civilName": "Juliana Ferreira Costa",
        "socialName": "Juh"
      }
    ],
    "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"
}

Property	Description	Required
fullName	Name of the account's owner.
companyName	For business connector, the business' name.
document	The primary document that identifies the owner.
documentType	Type of document collected.
taxNumber	The tax ID (CNPJ) associated with the business account.
jobTitle	Profession or Job information.
birthDate	Date of birth.
addresses	List of addresses related to the account.
phoneNumbers	List of phone numbers related to the account.
emails	List of email addresses related to the account.
relations	List of names related to the account.
investorProfile	Rating that indicates the investor's personality and motivation for investing. `Conservative`, `Moderate`, or `Aggressive`.
establishmentCode	Code of the establishment in the acquirer institution (only for PAYMENT_ACCOUNT connectors).
establishmentName	Name of the establishment (only for PAYMENT_ACCOUNT connectors).
socialName	Social name of the natural person, if any (PF-only, Open Finance).
sex	Sex of the natural person — `FEMALE`, `MALE`, or `OTHER` (PF-only, Open Finance).
maritalStatus	Marital status of the natural person (PF-only, Open Finance). See MaritalStatus schema.
nationality	Nationality of the natural person (PF-only, Open Finance). See Nationality schema.
otherDocuments	List of other identification documents held by the natural person — CNH, RG, NIF, RNE, or OTHER (PF-only, Open Finance). See OtherDocument schema.
passport	Passport metadata — applies when the natural person is a non-resident not required to register a CPF (PF-only, Open Finance). See Passport schema.
incorporationDate	Date the business was incorporated (PJ-only, Open Finance).
parties	Partners and administrators of the business (PJ-only, Open Finance). See BusinessParty schema.
businessOtherDocuments	Additional documents for businesses headquartered abroad and not required to register a CNPJ (PJ-only, Open Finance). See BusinessOtherDocument schema.
companiesCnpj	CNPJs of the financial institutions responsible for the customer cadastro (Open Finance, PF & PJ).
qualifications	Customer qualifications data (Open Finance). See Qualifications schema.
financialRelationships	Customer relationship with the institution (Open Finance). See FinancialRelationships schema.

Address Schema

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

{
  "fullAddress": "Av. Lúcio Costa 1234, Copacabana, 22620-171, Rio de Janeiro, Brasil",
  "country": "Brasil",
  "countryCode": "BRA",
  "state": "RJ",
  "city": "Rio de Janeiro",
  "district": "Copacabana",
  "ibgeTownCode": "3304557",
  "additionalInfo": "Casa amarela",
  "postalCode": "22620-171",
  "primaryAddress": "Av. Lúcio Costa, 1234",
  "type": "Personal",
  "geographicCoordinates": {
    "latitude": -22.9711,
    "longitude": -43.1822
  }
}

Property	Description
fullAddress	Full address using all components available.
country	The complete country name (free text).
countryCode	Country code in alpha3 ISO-3166 format (e.g. `BRA`). Open Finance only.
state	The state or province.
city	The complete city name.
district	District / neighborhood (bairro). Open Finance only.
ibgeTownCode	IBGE municipality code (7 digits). The first two digits identify the Federation Unit. Open Finance only.
additionalInfo	Additional address information such as apartment number, complement, or other details.
postalCode	The Zip code.
primaryAddress	Primary address, street name, and street number.
type	Type of address, `Personal` or `Work`.
geographicCoordinates	Geographic coordinates in decimal degrees, WGS84 reference system. Object with `latitude` and `longitude`. Open Finance only.

Email Schema

The email object contains emails associated with the account's owner.

{
  "type": "Personal",
  "value": "[email protected]"
}

Property	Description
type	`Personal` or `Work`.
value	The full email of the person.

Phone Schema

The phone number object contains data related to contact information.

{
  "type": "Personal",
  "value": "+55 (11) 987654321",
  "countryCallingCode": "55",
  "areaCode": "11",
  "extension": "501",
  "additionalInfo": "Office line"
}

Property	Description
type	`Personal`, `Work` or `Residencial`.
value	The complete phone number.
countryCallingCode	International dialing code (DDI). Populated when different from `55`. Open Finance only.
areaCode	Area code (DDD) of the phone. Open Finance only.
extension	Extension number, when part of the phone identification. Open Finance only.
additionalInfo	Additional info about the phone, e.g. when the source type doesn't fit the standard categories. Open Finance only.

Relation Schema

The relation object contains the name and relation with the account's owner.

{
  "type": "Father",
  "name": "Juan Gonzalez"
}

Property	Description
type	`Father`, `Mother` or `Spouse`.
name	The full name of the person.

MaritalStatus Schema

Marital status of the natural person (PF-only, Open Finance).

{
  "code": "MARRIED",
  "additionalInfo": "Civil partnership"
}

Property	Description
code	`SINGLE`, `MARRIED`, `WIDOWED`, `JUDICIALLY_SEPARATED`, `DIVORCED`, `STABLE_UNION`, or `OTHER`.
additionalInfo	Free-text complement. Should be set when `code` is `OTHER`.

Nationality Schema

Nationality of the natural person (PF-only, 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"
        }
      ]
    }
  ]
}

Property	Description
hasBrazilianNationality	Whether the client has Brazilian nationality.
otherNationalities	Other nationalities held by the client, if any.

Each otherNationalities[] entry:

Property	Description
countryCode	Country code in alpha3 ISO-3166 format.
documents	Supporting documents for this nationality. See `NationalityDocument`.

Each documents[] entry (NationalityDocument):

Property	Description
type	Document type (free text). Required when the nationality is not Brazilian.
number	Document number. Required when the nationality is not Brazilian.
country	Country name.
issueDate	Issue date of the document.
expirationDate	Expiration date of the document.
additionalInfo	Free-text complement.

OtherDocument Schema

Other identification documents the natural person holds (PF-only, Open Finance). Brazilian acronyms are kept verbatim; OTHER covers any other type.

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

Property	Description
type	`CNH`, `RG`, `NIF`, `RNE`, or `OTHER`.
typeAdditionalInfo	Free-text complement. Should be set when `type` is `OTHER`.
number	Document number.
checkDigit	Check digit of the document, if it has one.
additionalInfo	Free-text complement, used to record the issuing authority (e.g. `SSP/SP`) when relevant.
expirationDate	Expiration date of the document.

Passport Schema

Passport metadata for the natural person (PF-only, Open Finance). Applies when the client is a non-resident not required to register a CPF.

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

Property	Description
number	Passport number.
country	Issuing country in alpha3 ISO-3166 format.
issueDate	Issue date of the passport.
expirationDate	Expiration date of the passport.

BusinessParty Schema

Partner or administrator of a business (PJ-only, Open Finance). Partners with less than 25% shareholding may be omitted by the institution.

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

Property	Description
type	`PARTNER` (sócio) or `ADMINISTRATOR` (administrador).
personType	`NATURAL_PERSON` or `LEGAL_ENTITY`.
documentType	`CPF`, `CNPJ`, `PASSPORT`, or `OTHER_TRAVEL_DOCUMENT`.
documentNumber	Number of the identification document (digits and check digit, if any).
documentCountry	Issuing country of the document, alpha3 ISO-3166.
documentExpirationDate	Expiration date of the document.
documentIssueDate	Issue date of the document.
documentAdditionalInfo	Free-text complement when the document carries identification info that doesn't fit the other fields.
civilName	Civil name of the party. Required when `personType` is `NATURAL_PERSON`.
socialName	Social name of the natural-person party, if any.
companyName	Company name of the party. Required when `personType` is `LEGAL_ENTITY`.
tradeName	Trade name of the legal-entity party, if any.
startDate	Date the party's participation started.
shareholding	Shareholding fraction between 0 and 1 (e.g. `0.51` represents 51%, `1` represents 100%). Required when `type` is `PARTNER` and the shareholding is 25% or higher.

BusinessOtherDocument Schema

Additional document for businesses headquartered abroad and not required to register a CNPJ (PJ-only, Open Finance).

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

Property	Description
type	Type of the document (e.g. `EIN`).
number	Document number.
country	Issuing country in alpha3 ISO-3166 format.
expirationDate	Expiration date of the document.

Qualifications Schema

Customer qualifications data (Open Finance).

{
  "companyCnpj": "38512121000195",
  "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
  }
}

Property	Description
companyCnpj	CNPJ of the company associated with the qualifications.
occupationCode	`RECEITA_FEDERAL`, `CBO`, or `OUTRO`.
occupationDescription	Free-text occupation description. Holds the standardized list code when `occupationCode` is `RECEITA_FEDERAL` or `CBO`; the custom description when `OUTRO`.
informedIncome	Informed income. Object with `frequency` (`DIARIA`, `SEMANAL`, `QUINZENAL`, `MENSAL`, `BIMESTRAL`, `TRIMESTRAL`, `SEMESTRAL`, `ANUAL`, `OUTROS`), `amount`, and `date`.
informedPatrimony	Informed patrimony. Object with `amount`, `year`, and optionally `date` (returned on the PJ business path).
economicActivities	CNAE codes describing the economic activities of the business (PJ-only). Each entry has `code` (7-digit CNAE) and `isMain` boolean.
informedRevenue	Revenue (faturamento) informed by the business — the business equivalent of `informedIncome` (PJ-only). Object with `amount`, optional `frequency` (`DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `BIMONTHLY`, `QUARTERLY`, `SEMIANNUAL`, `ANNUAL`, `OTHER`), `frequencyAdditionalInfo`, and `year`.

FinancialRelationships Schema

Customer relationship with the institution (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"
    }
  ]
}

Property	Description
startDate	Date when the relationship with the institution started.
productsServicesType	List of products and services that the client consumes (e.g. `CONTA_DEPOSITO_A_VISTA`, `CARTAO_CREDITO`, `OPERACAO_CREDITO`).
productsServicesTypeAdditionalInfo	Additional info about the products and services. Populated when `productsServicesType` includes `OUTROS`.
procurators	List of procurators. Each entry has `type` (`REPRESENTANTE_LEGAL` or `PROCURADOR`), `cpfNumber` (legacy — may carry a CNPJ on PJ), the canonical `documentNumber` + `documentType` (`CPF` / `CNPJ`) pair, `civilName`, and optional `socialName`.
accounts	List of consented accounts. Each entry has `compeCode`, `branchCode`, `number`, `checkDigit`, `type` (`CONTA_DEPOSITO_A_VISTA`, `CONTA_POUPANCA`, `CONTA_PAGAMENTO_PRE_PAGA`), and `subtype` (`INDIVIDUAL`, `CONJUNTA_SIMPLES`, `CONJUNTA_SOLIDARIA`).
portabilitiesReceived	Salary portabilities received by the institution from the client's previous paycheck banks (banco-folha). PF-only. See entry schema below.
paychecksBankLink	Paycheck-bank (banco-folha) links to employers, active or formerly active. PF-only. See entry schema below.

Each portabilitiesReceived[] entry:

Property	Description
employerName	Employer name as received in the portability message.
employerDocument	Employer document (CPF or CNPJ) as received in the portability message.
paycheckBankDetainerCnpj	CNPJ of the bank that holds the paycheck account (banco-folha).
paycheckBankDetainerIspb	ISPB of the bank that holds the paycheck account.
portabilityApprovalDate	Date the portability was approved.

Each paychecksBankLink[] entry:

Property	Description
employerName	Employer name as registered when the paycheck account was opened.
employerDocument	Employer document (CPF or CNPJ) as registered when the paycheck account was opened.
paycheckBankCnpj	CNPJ of the institution contracted to provide the paycheck service (banco-folha).
paycheckBankIspb	ISPB of the institution contracted to provide the paycheck service.
accountOpeningDate	Date the paycheck account was opened.

📘
See Identity in our API reference for more information.