For the complete documentation index, see llms.txt. This page is also available as Markdown.

Trabalhista

Histórico Profissional (PF10)

Retorna uma lista de empresas para as quais a pessoa provavelmente trabalha ou já trabalhou, e o período de cada experiência profissional.

Seção: pfOccupationData

Parâmetro obrigatório: cpf

Parâmetro opcional: birthDate Esta informação é exigida em algumas fontes para concluir a execução de menores de idade

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.professions

Array

Lista de objetos com os detalhes de cada cargo encontrado

data.professions[x].sector

String

Setor da empresa

data.professions[x].companyIdNumber

String

Número de identificação da empresa (CNPJ)

data.professions[x].companyName

String

Nome da empresa (nome fantasia)

data.professions[x].status

String

Situação de emprego (ATIVO / INATIVO)

data.professions[x].incomeRange

String

Faixa salarial

data.professions[x].startDate

Data

Data de início ou admissão no emprego

data.professions[x].endDate

Data

Data de término ou desligamento do emprego

data.professions[x].lastUpdateDate

Data

Data da última atualização

data.isEmployed

Booleano

Indica se a pessoa está empregada ou não

{
  "statusCode": "01",
  "data": {
    "professions": [
      {
        "sector": "PRIVADO - XXXXXXX - TI",
        "companyIdNumber": "61160438000636",
        "companyName": "COMBATEAFRAUDE TECNOLOGIA DA INFORMACAO S.A.",
        "status": "ATIVO",
        "incomeRange": "",
        "startDate": "2018-03-13T00:00:00Z",
        "endDate": "9999-12-31T23:59:59.9999999",
        "lastUpdateDate": "2022-08-19T00:00:00Z"
      }
    ],
    "isEmployed": "true"
  }
}

Relacionamentos Econômicos (PF36)

Retorna a lista de entidades relacionadas ao indivíduo consultado em um contexto econômico, o que inclui tipos de relacionamento como participações societárias em empresas e vínculos empregatícios (cujos detalhes podem ser vistos no conjunto de dados de Dados Profissionais, entre outros).

Seção: pfBusinessRelationships

Parâmetro obrigatório: cpf

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.businessRelationships

Array

Array de objetos com relacionamentos econômicos

data.businessRelationships[x].relatedEntityTaxIdNumber

String

Número da entidade relacionada

data.businessRelationships[x].relatedEntityTaxIdType

String

Tipo de identificação da entidade

data.businessRelationships[x].relatedEntityName

String

Nome

data.businessRelationships[x].relationshipType

String

Tipo de relacionamento

data.businessRelationships[x].relationshipLevel

String

Nível do relacionamento

data.businessRelationships[x].relationshipStartDate

String

Data de início do relacionamento

data.businessRelationships[x].relationshipEndDate

String

Fim do relacionamento

data.businessRelationships[x].lastUpdateDate

String

Última atualização

Assistência Social do Governo (PF16)

Retorna se a pessoa faz parte do Bolsa Família ou de outro benefício do governo. Junto com o valor desses benefícios.

Seção: pfSocialAssistance

Parâmetro obrigatório: cpf

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.socialAssistances

Array

Lista de programas de assistência social

data.socialAssistances[x].programName

String

Nome do programa

data.socialAssistances[x].programState

String

Estado em que o programa é aplicado

data.socialAssistances[x].assistanceAmount

String

Valor recebido pelo programa de assistência

data.totalAssistances

String

Valor total de assistência que a pessoa recebeu

data.isReceivingAssistance

Booleano

Indica se a pessoa está recebendo alguma assistência atualmente

Conselhos de Classe (PF37)

Retorna se esta pessoa está associada a algum conselho de classe, como: OAB, CREA, CRA, ...

Seção: pfClassOrganization

Parâmetro obrigatório: cpf

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

memberships

Array

Dados da organização de classe

memberships[x].organizationName

String

Nome da organização

memberships[x].organizationCountry

String

País da organização

memberships[x].organizationType

String

Tipo da organização

memberships[x].organizationChapter

String

Estado em que a organização atua

memberships[x].registrationId

String

ID de registro

memberships[x].category

String

Categoria

memberships[x].status

String

Situação

memberships[x].membershipStartDate

String

Data em que a pessoa ingressou

memberships[x].membershipEndDate

String

Data de término da filiação

Regra
Descrição

has_no_class_organizations

Verifica se o CPF tem vínculos com associações profissionais.

Débitos Trabalhistas (PF98)

Retorna o resultado da emissão de uma certidão negativa de débitos trabalhistas para um CPF informado

Seção: pfLaborDebts

Parâmetro obrigatório: cpf

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Mensagem de retorno

data.status

String

Status (encontrado/não encontrado)

data.certificateValidity

String

Validade da certidão

Regra
Descrição

has_no_labor_debts

A regra será inválida se houver dívidas trabalhistas.

Servidor Público (PF34)

Retorna informações agregadas e detalhadas de servidores públicos. Esta consulta retorna dados como indicador e detalhes do servidor público.

Seção: pfProfessionData

Parâmetro obrigatório: cpf

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.professions

Array

Lista de objetos com os detalhes de cada cargo encontrado

data.professions[x].source

String

Fonte da informação

data.professions[x].sector

String

Setor da empresa

data.professions[x].state

String

Estado da empresa

data.professions[x].country

String

País em que a profissão é exercida

data.professions[x].companyIdNumber

String

Número de identificação da empresa (CNPJ)

data.professions[x].companyName

String

Nome da empresa

data.professions[x].area

String

Área da empresa onde a pessoa trabalha

data.professions[x].level

String

Cargo ou função (quando disponível)

data.professions[x].status

String

Situação de emprego.

data.professions[x].incomeRange

String

Faixa salarial estimada para este cargo

data.professions[x].income

Número

Renda estimada fornecida por este trabalho

data.professions[x].startDate

Data

Data de início ou admissão no trabalho

data.professions[x].endDate

Data

Data de término ou desligamento do emprego

data.professions[x].situation

String

Situação do funcionário

data.professions[x].isDead

String

Funcionário é falecido

data.professions[x].companyAdmissionDate

String

Data de admissão na empresa

data.professions[x].jobFunction

String

Função do cargo

data.professions[x].jobRole

String

Cargo

data.professions[x].servantType

String

Tipo de funcionário

data.professions[x].workload

String

Carga horária

data.professions[x].organType

String

Tipo de órgão

data.professions[x].headBranch

String

Matriz

data.professions[x].incomeHistory

Array

Histórico de pagamentos

data.professions[x].incomeHistory[x].income

String

Valor recebido

data.professions[x].incomeHistory[x].referenceDate

Data

Data de referência

data.professions[x].averageIncome

Número

Salário médio

data.professions[x].maxIncome

Número

Maior valor recebido

data.professions[x].minIncome

Número

Menor valor recebido

data.professions[x].registrationNumber

String

Número de registro

data.professions[x].creationDate

Data

Data de criação

data.professions[x].lastUpdateDate

Data

Data da última atualização

data.professions[x].totalProfessions

Número

Número total de ocupações exercidas

data.professions[x].totalActiveProfessions

Número

Número total de profissões ativas

data.professions[x].totalIncomeRange

String

Faixa de renda

data.professions[x].totalIncome

Número

Renda total

data.professions[x].isEmployed

Booleano

Indica se a pessoa está empregada ou não

Atualizado