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.

{
  "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"
}

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	Is a 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)

Address Schema

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

{
  "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"
}

Property	Description
fullAddress	Full address using all components available.
country	The complete country name.
state	The state or province.
city	The complete city name.
additionalInfo	The additional address information.
postalCode	The Zip code.
primaryAddress	Primary address, street name, and street number.
type	Type of address, `Personal` or `Work`.

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": "+54 911 12345678"
}

Property	Description
type	`Personal`, `Work` or `Residencial`.
value	The complete phone number.

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`.
value	The full name of the person.

📘
See Identity in our API reference for more information.