profile 1.0 · Pessoa
Cadastro base de um CPF na Receita Federal: existencia do documento, identificacao, filiacao, obito e situacao cadastral.
| Entidade | Pessoa (CPF, entity: pf) |
| Módulo | profile |
| Versão | 1.0 |
| Dataset | person-profile-1.0 |
| Execução | Sempre roda: é o módulo que localiza o titular |
Este é o formato de data.profile em GET /api/v3/enrichments/{id}?include=profile e o corpo de GET /api/v3/enrichments/{id}/modules/profile. 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 a data.profile.
Envelope
| Campo | Tipo | Observação |
|---|---|---|
dataset | string | sempre person-profile-1.0 |
module | string | sempre profile |
profile | object | os dados do módulo (abaixo) |
rules | array<object> | os indicadores avaliados pelo dataset (abaixo) |
Dados
identification
| Campo | Tipo | Observação |
|---|---|---|
profile.exists | boolean | |
profile.name | string | |
profile.gender | string | |
profile.birthDate | string | date |
profile.nationality | string | |
profile.isDeceased | boolean | |
profile.parents.mother | string | |
profile.parents.father | string | |
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 |
Indicadores (rules)
| Campo | Tipo | Observação |
|---|---|---|
rules[].evidence | object | Os dados que sustentam o indicador, quando disparou. |
rules[].fired | boolean | true quando o indicador se aplica aos dados. |
rules[].magnitude | number | Intensidade do achado, quando ele tem uma (ex.: uma contagem ou um valor). |
rules[].notApplicable | boolean | true quando o indicador não pôde ser avaliado porque o dado que ele lê está ausente. Não é o mesmo que não disparar. |
rules[].reason | string | Por que o indicador não pôde ser avaliado (com notApplicable). |
rules[].rule | string | PROFILE_PERSON_DECEASED, PROFILE_PERSON_IRREGULAR_STATUS — Nome do indicador. |
Indicadores publicados por este dataset:
PROFILE_PERSON_DECEASEDPROFILE_PERSON_IRREGULAR_STATUS