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 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-1.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.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

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