Atualizações da API
02/09/2021 - Removida a documentação da Restrições SPC (PF45 / PJ62)
Removida a documentação da Restrições SPC (PF45 / PJ62), a mesma está sendo substituida pela SPC Restrições + Score (PF99 / PJ99), a qual já possui documentação disponível.
23/08/2021 - Removida a documentação da Processos Judiciais e Administrativos (PF15)
Depois de concluido o processo de migração da pf_processes (PF15) para pf_processes_alt (PF48), foi removido a documentação da pf_processes (PF15).
23/08/2021 - Adicionado uma nova opção para a fonte de processos judiciais
Adicionado a pj_processes_alt (PJ66), uma segunda opção para a busca de processos judiciais, com o mesmo parâmetro (CNPJ) mas com resposta diferente.
Seção: pj_processes_alt
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.total | Number | Quantidade total de processos |
data.results | Array | Lista de processos retornada |
data.results[x].id | String | Identificador da consulta |
data.results[x].criminalCategory | String | Categoria do processo |
data.results[x].lawsuitClass | String | Classe |
data.results[x].distributionDate | String | Data da distribuição |
data.results[x].statusDate | String | Data do status |
data.results[x].lawsuitDegree | String | Grau do processo |
data.results[x].physicalLocation | String | Local físico |
data.results[x].oldLawsuitNumber | String | Número antigo do processo |
data.results[x].judgingBody | String | Órgão julgador |
data.results[x].lawsuitId | String | Número do processo |
data.results[x].isDigitalLawsuit | Boolean | Se o processo é digital |
data.results[x].lawBranch | String | Ramo do Direito |
data.results[x].segment | String | Segmento |
data.results[x].isJusticeSecret | Boolean | Se é segredo de justiça |
data.results[x].complementaryStatus | String | Status complementar |
data.results[x].observationStatus | String | Status da observação |
data.results[x].court | String | Tribunal |
data.results[x].state | String | UF |
data.results[x].sourceUnit | String | Unidade de origem |
data.results[x].lawsuitUrl | String | URL do processo |
data.results[x].lawsuitValue | Object | Retorno do valor do processo |
data.results[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) |
data.results[x].lawsuitValue.value | Number | Valor |
data.results[x].subjects | String Array | Lista de assuntos |
data.results[x].moves | Array | Lista de movimentações do processo |
data.results[x].moves[x].date | String | Data da movimentação |
data.results[x].moves[x].description | String | Descrição da movimentação |
data.results[x].actives | Array | Lista dos ativos |
data.results[x].actives[x].cnpj | String | CNPJ |
data.results[x].actives[x].cpf | String | CPF |
data.results[x].actives[x].name | String | Nome |
data.results[x].actives[x].type | String | Tipo |
data.results[x].actives[x].lawyers | Array | Lista de Advogados |
data.results[x].actives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].actives[x].lawyers[x].name | String | Nome |
data.results[x].actives[x].lawyers[x].cpf | String | CPF |
data.results[x].passives | Array | Lista de passivos |
data.results[x].passives[x].cnpj | String | CNPJ |
data.results[x].passives[x].cpf | String | CPF |
data.results[x].passives[x].name | String | Nome |
data.results[x].passives[x].type | String | Tipo |
data.results[x].passives[x].lawyers | Array | Lista de Advogados |
data.results[x].passives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].passives[x].lawyers[x].name | String | Nome |
data.results[x].passives[x].lawyers[x].cpf | String | CPF |
data.results[x].authorType | String | Tipo do autor |
05/07/2021 - Alteração na fonte de antecedentes criminais (Federal)
A fonte pfCriminalBackground teve seu nome alterado para pfBackgroundCheckFederalPolice:
Seção: pfBackgroundCheckFederalPolice
pfCriminalBackground
22/06/2021 - Fonte indisponível e descontinuada
A seguinte fonte foi desativada e não está mais funcional.
Seção: pfSeguroDesemprego
Parâmetro obrigatório: cpf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.name | String | Nome |
data.nitNumber | String | Número NIT |
data.insuranceStatus | String | Status do Seguro |
data.periodOfEmployment | String | Período empregatício |
data.procedure | String | Procedimento |
data.reason | String | Razão para a demissão |
data.queryDate | String | Data de realização da consulta |
20/05/2021 - Alteração na fonte de processos judiciais
A fonte pfProcesses mudou seu nome para pfProcessesAlt e teve uma mudança estrutural significativa.
Seção: pf_processes_alt
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.results | Array | Lista de processos retornada |
data.results[x].id | String | Identificador da consulta |
data.results[x].criminalCategory | String | Categoria do processo |
data.results[x].lawsuitClass | String | Classe |
data.results[x].distributionDate | String | Data da distribuição |
data.results[x].statusDate | String | Data do status |
data.results[x].lawsuitDegree | String | Grau do processo |
data.results[x].physicalLocation | String | Local físico |
data.results[x].oldLawsuitNumber | String | Número antigo do processo |
data.results[x].judgingBody | String | Órgão julgador |
data.results[x].lawsuitId | String | Número do processo |
data.results[x].isDigitalLawsuit | Boolean | Se o processo é digital |
data.results[x].lawBranch | String | Ramo do Direito |
data.results[x].segment | String | Segmento |
data.results[x].isJusticeSecret | Boolean | Se é segredo de justiça |
data.results[x].complementaryStatus | String | Status complementar |
data.results[x].observationStatus | String | Status da observação |
data.results[x].court | String | Tribunal |
data.results[x].state | String | UF |
data.results[x].sourceUnit | String | Unidade de origem |
data.results[x].lawsuitValue | Object | Retorno do valor do processo |
data.results[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) |
data.results[x].lawsuitValue.value | Number | Valor |
data.results[x].subjects | String Array | Lista de assuntos |
data.results[x].moves | Array | Lista de movimentações do processo |
data.results[x].moves[x].date | String | Data da movimentação |
data.results[x].moves[x].description | String | Descrição da movimentação |
data.results[x].actives | Array | Lista dos ativos |
data.results[x].actives[x].cnpj | String | CNPJ |
data.results[x].actives[x].cpf | String | CPF |
data.results[x].actives[x].name | String | Nome |
data.results[x].actives[x].type | String | Tipo |
data.results[x].actives[x].lawyers | Array | Lista de Advogados |
data.results[x].actives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].actives[x].lawyers[x].name | String | Nome |
data.results[x].actives[x].lawyers[x].cpf | String | CPF |
data.results[x].passives | Array | Lista de passivos |
data.results[x].passives[x].cnpj | String | CNPJ |
data.results[x].passives[x].cpf | String | CPF |
data.results[x].passives[x].name | String | Nome |
data.results[x].passives[x].type | String | Tipo |
data.results[x].passives[x].lawyers | Array | Lista de Advogados |
data.results[x].passives[x].lawyers[x].oab | String | Número da OAB |
data.results[x].passives[x].lawyers[x].name | String | Nome |
data.results[x].passives[x].lawyers[x].cpf | String | CPF |
data.results[x].authorType | String | Tipo do autor |
data.total | Number | Quantidade total de processos |
03/01/2020 - Alteração nas seções das execuções
Os atributos das seções facematch e officialData tiveram suas respostas alteradas:
Facematch retornará o percentual de semelhança na escala de 0 a 1. (atributo
sections.facematch.confidence
);Official Data possui o formato abaixo:
{
...documento da execução
"sections": {
...demais seções
"officialData": {
"code": "01",
"confidence": 0.999,
"probability": "Altíssima probabilidade"
}
}
}
16/08/2019 - Novo formato dos tokens de acesso
Nas versões anteriores, cada relatório possuia um token de acesso. A partir do dia de hoje o token é único por conta, ou seja, todos os relatórios possuem a mesma credencial.
Não é uma atualização que gera breaking changes, portanto, não necessita de migração na maneira como é feita a integração.
Os tokens antigos continuam válidos. Porém, recomenda-se a utlização do novo token.