v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Identity

Find by item

Recovers identity of an item if available

get/identity

Query parameters

itemIdstring uuid required

Item's primary identifier

Response

Retrieve an identity by itemId

idstring required

The ID of the identity to retrieve

itemIdstring uuid required

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

investorProfile'Conservative' | 'Moderate' | 'Aggressive'

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

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

sex'FEMALE' | 'MALE' | 'OTHER'

Sex of the natural person. PF-only field

incorporationDatestring date-time

Date the business was incorporated. PJ-only field

companiesCnpjstring[]

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