profile 2.0 · Pessoa
Cadastro base de um CPF mais os contatos conhecidos: telefones, e-mails e enderecos com quantas fontes confirmam cada um, o canal preferencial, e os sinais de estrangeiro e de exposicao politica.
| Entidade | Pessoa (CPF, entity: pf) |
| Módulo | profile |
| Versão | 2.0 (mais recente) |
| Dataset | person-profile-2.0 |
| Execução | Sempre roda: é o módulo que localiza o titular |
Este é o formato do corpo de GET /api/v3/enrichments/{id}/modules/profile, a rota que a url do módulo, na raiz do enriquecimento, aponta. Os campos são publicados como o dataset os entrega: um campo ausente significa que o dado não foi obtido, não que o valor é falso ou zero. Os caminhos abaixo são relativos ao corpo da resposta.
Envelope
| Campo | Tipo | Observação |
|---|---|---|
dataset | string | sempre person-profile-2.0 |
module | string | sempre profile |
profile | object | os dados do módulo (abaixo) |
Dados
identification
| Campo | Tipo | Observação |
|---|---|---|
profile.exists | boolean | |
profile.name | string | |
profile.gender | string | |
profile.birthDate | string | date |
profile.nationality | string | |
profile.isForeign | boolean | |
profile.origin | string | |
profile.isDeceased | boolean | |
profile.politicallyExposed | boolean | |
profile.parents.mother | string | |
profile.parents.father | string | |
profile.parents.motherConfirmed | boolean | |
profile.alternativeIds.socialSecurity | string |
taxStatus
| Campo | Tipo | Observação |
|---|---|---|
profile.taxId.number | string | |
profile.taxId.status | string | |
profile.taxId.statusDate | string | date |
profile.taxId.origin | string | |
profile.taxId.country | string | |
profile.taxId.fiscalRegion | string |
record
| Campo | Tipo | Observação |
|---|---|---|
profile.record.createdAt | string | date |
profile.record.updatedAt | string | date |
contactPhones
| Campo | Tipo | Observação |
|---|---|---|
profile.contacts.phones.oldestPassageAt | string | date |
profile.contacts.phones.newestPassageAt | string | date |
profile.contacts.phones.items | array<object> | |
profile.contacts.phones.items[].active | boolean | |
profile.contacts.phones.items[].areaCode | string | |
profile.contacts.phones.items[].carrier | string | |
profile.contacts.phones.items[].confirmations | integer | |
profile.contacts.phones.items[].countryCode | string | |
profile.contacts.phones.items[].createdAt | string | date |
profile.contacts.phones.items[].doNotCall | boolean | |
profile.contacts.phones.items[].lastSeenAt | string | date |
profile.contacts.phones.items[].main | boolean | |
profile.contacts.phones.items[].number | string | |
profile.contacts.phones.items[].planType | string | |
profile.contacts.phones.items[].preferred | boolean | |
profile.contacts.phones.items[].type | string | |
profile.contacts.phones.items[].updatedAt | string | date |
contactEmails
| Campo | Tipo | Observação |
|---|---|---|
profile.contacts.emails.oldestPassageAt | string | date |
profile.contacts.emails.newestPassageAt | string | date |
profile.contacts.emails.items | array<object> | |
profile.contacts.emails.items[].active | boolean | |
profile.contacts.emails.items[].address | string | |
profile.contacts.emails.items[].confirmations | integer | |
profile.contacts.emails.items[].createdAt | string | date |
profile.contacts.emails.items[].domain | string | |
profile.contacts.emails.items[].lastSeenAt | string | date |
profile.contacts.emails.items[].main | boolean | |
profile.contacts.emails.items[].preferred | boolean | |
profile.contacts.emails.items[].type | string | |
profile.contacts.emails.items[].updatedAt | string | date |
profile.contacts.emails.items[].validationStatus | string |
contactAddresses
| Campo | Tipo | Observação |
|---|---|---|
profile.contacts.addresses.oldestPassageAt | string | date |
profile.contacts.addresses.newestPassageAt | string | date |
profile.contacts.addresses.items | array<object> | |
profile.contacts.addresses.items[].active | boolean | |
profile.contacts.addresses.items[].city | string | |
profile.contacts.addresses.items[].complement | string | |
profile.contacts.addresses.items[].confirmations | integer | |
profile.contacts.addresses.items[].country | string | |
profile.contacts.addresses.items[].createdAt | string | date |
profile.contacts.addresses.items[].lastSeenAt | string | date |
profile.contacts.addresses.items[].main | boolean | |
profile.contacts.addresses.items[].neighborhood | string | |
profile.contacts.addresses.items[].number | string | |
profile.contacts.addresses.items[].preferred | boolean | |
profile.contacts.addresses.items[].state | string | |
profile.contacts.addresses.items[].street | string | |
profile.contacts.addresses.items[].type | string | |
profile.contacts.addresses.items[].updatedAt | string | date |
profile.contacts.addresses.items[].zipCode | string |
timeline
| Campo | Tipo | Observação |
|---|---|---|
profile.timeline | array<object> | |
profile.timeline[].amountBrl | number | |
profile.timeline[].basis | string | |
profile.timeline[].date | string | |
profile.timeline[].detail | string | |
profile.timeline[].event | string | |
profile.timeline[].precision | string | |
profile.timeline[].ref | string | |
profile.timeline[].source | string |