GET/identity

Find by item

Recovers identity of an item if available

Parameters

Query Parameters

Name	Type	Description
`itemId`required	string (uuid)	Item's primary identifier

Responses

200Retrieve an identity by itemId

object

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

idrequiredstring

The ID of the identity to retrieve

itemIdrequiredstring (uuid)

Identifier of the item linked to the identity

birthDatestring (date-time)

Date of birth

taxNumberstring

The tax ID (CNPJ) associated with the business account

documentstring

Primary document that identifies the owner

documentTypestring

Type of document collected

jobTitlestring

Profession or Job information

fullNamestring

Name of the owner of the account

establishmentCodestring

Establishment code (only for PAYMENT_ACCOUNT connectors)

establishmentNamestring

Name of the establishment (only for PAYMENT_ACCOUNT connectors)

companyNamestring

For business connector, the name of the business

phoneNumbersobject[]

List of phone numbers related to the account

itemsobject

The phone number object contains data related to contact information.

emailsobject[]

List of email addresses related to the account

itemsobject

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

addressesobject[]

List of addresses related to the account

itemsobject

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

relationsobject[]

List of names related to the account

itemsobject

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

investorProfilestring

Is a rating that indicates the investor personality and motivation for investing

ConservativeModerateAggressive

qualificationsobject

Information that allows understanding since when the consulted person has been a client of the institution, as well as an indicator of the products and services they currently consume and their representatives

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

Information that allows institutions to assess, evaluate, characterize, and classify the client with the purpose of understanding their risk profile and their economic-financial capacity

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

Social name of the natural person, if any (the name by which travestis and transsexuals recognize themselves and are recognized in their community). PF-only field

sexstring

Sex of the natural person. PF-only field

FEMALEMALEOTHER

maritalStatusobject

Marital status of the natural person. PF-only field

All of:

part 1object

Marital status of the natural person

nationalityobject

Nationality of the natural person. PF-only field

All of:

part 1object

Nationality of the natural person

otherDocumentsobject[]

List of other identification documents the natural person holds. PF-only field

itemsobject

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

passportobject

Passport metadata for the natural person. PF-only field

All of:

part 1object

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

incorporationDatestring (date-time)

Date the business was incorporated. PJ-only field

partiesobject[]

Partners and administrators of the business. PJ-only field

itemsobject

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

businessOtherDocumentsobject[]

List of additional documents for businesses headquartered abroad and not required to register a CNPJ. PJ-only field

itemsobject

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

companiesCnpjstring[]

CNPJs of the financial institutions responsible for the customer cadastro. Numbers only, no mask

itemsstring

Example response

json

{
  "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",
  "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@pluggy.ai"
    }
  ],
  "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"
}

Code Examples

bash

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

Try It

API Key

Query Parameters

itemId*