GET
Buscar identidade por item

Authorizations

X-API-KEY
string
header
required

Chave de API obrigatória em todos os endpoints. Envie no header X-API-KEY: <apiKey>.

Query Parameters

itemId
string<uuid>
required

Identificador primário do item.

Response

Objeto IdentityResponse.

Dados cadastrais do titular do item. Conectores diretos retornam apenas os campos core. Conexões reguladas do Open Finance trazem extras: qualifications e financialRelationships, além de campos exclusivos de PF (ex.: socialName, sex, maritalStatus, nationality, otherDocuments, passport) e de PJ (ex.: incorporationDate, parties, businessOtherDocuments, companiesCnpj). Todos os campos além de id e itemId são opcionais/nullable.

id
string<uuid>
required

Id da identidade.

itemId
string<uuid>
required

Item vinculado.

fullName
string | null

Nome do titular.

document
string | null

Documento principal formatado (ex.: 076.630.975-48).

documentType
string | null

Tipo do documento coletado (ex.: CPF).

taxNumber
string | null

CNPJ associado a uma conta empresarial.

birthDate
string<date-time> | null
jobTitle
string | null

Profissão/cargo.

companyName
string | null

Para conectores empresariais, a razão social.

establishmentCode
string | null

Apenas para conectores PAYMENT_ACCOUNT.

establishmentName
string | null

Apenas para conectores PAYMENT_ACCOUNT.

investorProfile
enum<string> | null

Perfil de investidor.

Available options:
Conservative,
Moderate,
Aggressive,
null
addresses
object[] | null
phoneNumbers
object[] | null
emails
object[] | null
relations
object[] | null
qualifications
object | null

Extra do Open Finance (Regulado). Inclui companyCnpj (obrigatório), occupationCode, occupationDescription, informedIncome, informedPatrimony, economicActivities (PJ) e informedRevenue (PJ).

financialRelationships
object | null

Extra do Open Finance (Regulado). Inclui startDate, productsServicesType, procurators (obrigatórios), accounts, portabilitiesReceived (PF), paychecksBankLink (PF).

createdAt
string<date-time> | null
updatedAt
string<date-time> | null