Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O que é

Na consulta PGE - Dívida Ativa - você verifica se uma pessoa ou empresa possui dívida ativa no estado de São Paulo. A dívida ativa inclui vários tipos de débitos, como IPVA, ICMS.Veja mais informações em nossa central de ajuda: PGE SP - Dívida Ativa

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/pge-sp/divida-ativa

...

Include Page
URL Base
URL Base

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

cpf

String

Obrigatório se nenhum outro parâmetro for informado

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

cnpj

String

Obrigatório se nenhum outro parâmetro for informado

CNPJ a ser pesquisado, com ou sem máscara

cnpjBase

String

Obrigatório se nenhum outro parâmetro for informado

Raiz do CNPJ, primeira parte, com números antes da / ( barra ).

aiim

String

Obrigatório se nenhum outro parâmetro for informado

Número do AIIM - Auto de Infração e Imposição de Multa

etiqueta

String

Obrigatório se nenhum outro parâmetro for informado

inscricaoEstadualSp

String

Obrigatório se nenhum outro parâmetro for informado

Inscrição estadual, com ou sem máscara

renavam

String

Obrigatório se nenhum outro parâmetro for informado

Renavam do veículo

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

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

...

Code Block
{
  "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“

...