Background check¶

Nota

API em Beta fechado.

Esta API permite buscar processos de natureza criminal associados a uma parte.

Não são retornados nas buscas os processos que, no momento da consulta no tribunal por nossos robôs, constavam como em segredo de justiça. Normalmente consultamos os detalhes do processo no tribunal logo após a distribuição.

Realizar busca¶

A busca pelos processos é realizada de forma síncrona e os resultados são retornados de forma paginada. [Código do Produto: PCS_CH_BgCheckSearch].

Para obter os detalhes de capa de um processo específico retornado nos resultados, basta realizar uma segunda chamada para obter detalhes do processo em nossa base judicial. Importante: Nesta chamada de detalhes do processo, utilize o parâmetro de URL &tipo_numero=9.

POST https://op.digesto.com.br/api/background_check/search¶

No corpo da chamada é necessario enviar o número do documento da parte buscada como string, que pode ser formatado ou não, esse valor pode ser um CPF ou CNPJ.

Nota

Requer módulo “(IP/API) Background Check: Consultar processos criminais associado a um documento de parte”

Exemplo de chamada:

POST https://op.digesto.com.br/api/background_check/search HTTP/1.1
Content-Type: application/json

{"document": "08.475.335/0001-78"}

Exemplo de resposta:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
      "root": {
          "crmLawsuitsByPersonId": {
              "edges": [
                  {
                      "node": {
                          "cnjNumber": {
                              "number": "0XXXXXX-38.2014.8.13.0439"
                          },
                          "court": {
                              "rawValue": "TJMG"
                          },
                          "distributionDate": 1409713200000,
                          "distributionType": "Sorteio",
                          "district": "MURIAÉ/MG",
                          "forum": "VARA CÍVEL",
                          "id": "Q1JNTGF3c3VpdDp7Imxhd3N1aXRJZCI6IjQzODU3OGY2LWF1dG9tYXRpYzowLTAxMjk2MzYzODIwMTQ4MTMwNDM5LWxhd3N1aXQifQ==",
                          "kind": "indeterminado",
                          "normalizedNature": "OUTROS",
                          "value": 32510.58
                      }
                  },
                  {
                      "node": {
                          "cnjNumber": {
                              "number": "0XXXXXX-76.2010.8.18.0032"
                          },
                          "court": {
                              "rawValue": "TJPI"
                          },
                          "distributionDate": 1351216800000,
                          "distributionType": "Sorteio",
                          "district": "PICOS",
                          "forum": "Vara",
                          "id": "Q1JNTGF3c3VpdDp7Imxhd3N1aXRJZCI6ImVhNzMxOWFkLWF1dG9tYXRpYzowLTAwMDAyMDc3NjIwMTA4MTgwMDMyLWxhd3N1aXQifQ==",
                          "kind": null,
                          "normalizedNature": "OUTROS",
                          "value": 0
                      }
                  }
              ],
              "pageInfo": {
                  "endCursor": "eyJpZGVudGlmaWNhdGlvbk51bWJlciI6IjAwMDAwMDAwMDAwMTkxIiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQ05QSiIsInBhcnR5SWQiOiI0MTc5Mzg3Mjg2OTI1MDY1ODc4OjE3IiwibGF3c3VpdElkIjoiZWE3MzE5YWQtYXV0b21hdGljOjAtMDAwMDIwNzc2MjAxMDgxODAwMzItdcfdfcfvfv",
                  "hasNextPage": true
              }
          }
      }
  },
  "extensions": {
      "executionTime": 79,
      "extensionsExecutionTime": 0,
      "tracing": {}
  }

}

Request Headers:
	Authorization – token da API. Ver Autenticação.
Response Headers:
	Content-Type – `application/json`
Response JSON Object:
	crmLawsuitsByPersonId – Objeto que tem todos os processos associados. edges – Lista de objetos que contém o node com as informações do processo, score do processo para a busca e source. node – Objeto com informações do processo encontrado. cnjNumber (objeto): Objeto que contém o número do processo. court (objeto): Objeto que contém o nome do tribunal. distributionDate (integer): Data de distribuição do processo. O valor da data é o unix time (milisegundos desde epoch). distributionType (string): Tipo de distribuição. district (string): Comarca. forum (string): Foro. kind (string): Área do processo. confidenceLevel (string): Certeza sobre a associação deste CPF/CNPJ com a parte quantificado em ‘ALTA’, ‘MEDIA’ ou ‘BAIXA’. normalizedNature (string): Natureza do processo normalizada. value (float): Valor da causa. pageInfo – Objeto com informações referentes a próxima página. endCursor (string): Valor que tem o cursor para obter próxima página. hasNextPage (boolean): Informa se existe uma próxima página para ser obtida.

Paginação¶

Para trazer a segunda página dos resultados, quando houver, basta alterar o campo pagination passando o cursor que foi enviado na resposta da requisição anterior na chave pageInfo. O campo size representa o tamanho da página de resultados. Caso o size não seja especificado enviamos por padrão 10 processos por página. O valor máximo aceito para size é 500.

As informações sobre o cursor e indicador de que tem uma próxima página ficam na chave pageInfo de cada resposta.

Exemplo de chamada

POST https://op.digesto.com.br/api/background_check/search HTTP/1.1
Content-Type: application/json

{
  "document":"08.475.335/0001-78",
  "pagination":{
      "size":100,
      "cursor":"eyJpZGVudGlmaWNhdGlvbk51bWJlciI6IjAwMDAwMDAwMDAwMTkxIiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQ05QSiIsInBhcnR5SWQiOiI0MTc5Mzg3Mjg2OTI1MDY1ODc4OjE3IiwibGF3c3VpdElkIjoiZWE3MzE5YWQtYXV0b21hdGljOjAtMDAwMDIwNzc2MjAxMDgxODAwMzItdcfdfcfvfv"
  }
}