O que é#

Na consulta TST - Certidão de débito trabalhista você verifica e pode emitir certidão que atesta se uma pessoa ou empresa possui débitos trabalhistas.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/tst/certidao-debito-trabalhista

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
cpfCnpj string Sim CPF a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

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#

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

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

Status 422#

Significa que ocorreu um erro de validação dos dados enviados.

JSON
{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é 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

IMPORTANTE: Quando o documento informado não existe, o site do TST não envia a informação. A resposta é retornada na API, como sucesso, com status negativo e o nome da pessoa não é preenchido.

Resposta com registro encontrado#

JSON
{
  "cpfCnpj": "999.999.999-99",
  "nome": "FULANO DA SILVA",
  "certidao": "0000000/2020",
  "expedicao": "13/10/2020, às 08:55:28",
  "status": "negativa",
  "validade": " 10/04/2021",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
JSON
{
  "cpfCnpj": "999.999.999-99",
  "nome": "FULANO DA SILVA",
  "certidao": "0000000/2020",
  "expedicao": "13/10/2020, às 08:55:28",
  "status": "positiva",
  "validade": " 10/04/2021",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}