Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Current »

O que é

Com a certidão de distribuição do TJDFT você pode verificar se uma pessoa ou empresa possui ação em tramitação no órgão.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/tjdft/certidao-distribuicao

URL Base:

https://api.plexi.com.br/

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

Chave de API gerada no cadastro no Plexi, prefixada com Bearer

Callback

String

Não

URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

tipoCertidao

string

Sim

Tipo de certidão. A tabela abaixo apresenta os valores possíveis.

cpfCnpj

string

Sim

CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

nomeMae

string

Obrigatório caso o parâmetro cpfCnpj seja um CPF e tipoCertidao for criminal ou especial

Nome da mãe da pessoa, em caso de busca por CPF

Valores possíveis para o campo “tipoCertidao“

Valor

Descrição

criminal

CERTIDÃO CRIMINAL

civel

CERTIDÃO DE DISTRIBUIÇÃO CÍVEL

falencia_concordata

CERTIDÃO DE FALÊNCIA E RECUPERAÇÃO JUDICIAL

especial

CERTIDÃO DE DISTRIBUIÇÃO ESPECIAL (CÍVEL E CRIMINAL)

Retornos possíveis da requisição

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

Campo requestId, com o ID da requisição criada.

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos

Status 201

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

Status

Significado

negativo

NÃO foram encontrados débitos para o documento pesquisado

positivo

Foram encontrados débitos relacionados ao documento pesquisado

indefinido

Não foi possível afirmar se o documento pesquisado possui ou não débitos.

erro

Ocorreu um erro no site com os dados informados.

Resposta com registro encontrado

{
    "status": "positivo",
    "nome": "Fulano da Silva",
    "nomeMae": "Fulana da Silva",
    "nomeFantasia": "Empresa SA",
    "cpfCnpj": "99999999999999",
    "dataHoraSolicitacao": "25/10/2022 17:10:21",
    "dataHoraValidade": "25/10/2022 00:11:00",
    "dataHoraEmissao": "25/10/2022 17:10:21",
    "dataNascimento": null,
    "tipoCertidao": "CRIMINAL",
    "statusCertidao": "finalizada",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAo..."
}
{
    "status": "negativo",
    "nome": "Fulano da Silva",
    "nomeMae": "Fulana da Silva",
    "nomeFantasia": "Empresa SA",
    "cpfCnpj": "99999999999999",
    "dataHoraSolicitacao": "25/10/2022 17:10:21",
    "dataHoraValidade": "25/10/2022 00:11:00",
    "dataHoraEmissao": "25/10/2022 17:10:21",
    "dataNascimento": null,
    "tipoCertidao": "CRIMINAL",
    "statusCertidao": "finalizada",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAo..."
}
{
    "status": "indefinido",
    "mensagem": "Já existe uma solicitação de certidão desse tipo e para esse CPF/CNPJ em análise.",
    "pdf": JVBERi0xLjQKMSAwIG9iago8PAo..."
}

Resposta com erro

{
    "status": "erro",
    "mensagem": "Ocorreu um erro ao recuperar os dados do solicitante.",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAo..."
}
{
    "status": "erro",
    "mensagem": "Nome da mãe não é igual ao da receita",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAo..."
}
  • No labels