Ir para o conteúdo
AvaliService

Documentação técnica · API REST

AvaliService

A API de dados que não te deixa na mão.

Versão
2.0
Atualização
19/08/2026
Contrato
OpenAPI 3.0.1
Endpoints
84

URL base https://api.avaliservice.com.br Swagger ao vivo ↗

Referência completa dos 84 endpoints da API AvaliService: autenticação, comunicado de venda, 68 consultas veiculares e de crédito, CRLV digital por UF, CNH, dados cadastrais de pessoas e empresas e processos judiciais. Cada consulta é uma chamada independente, com resposta própria.

Fluxo de autenticação

A API utiliza autenticação via JWT Bearer Token. O token tem validade de 24 horas. Todas as requisições (exceto login) devem incluir o cabeçalho:

Authorization: Bearer <seu_token_jwt>
  1. Faça uma requisição POST para /api/Auth/login com suas credenciais.
  2. Receba o token JWT na resposta (válido por 24 horas).
  3. Inclua o token no cabeçalho Authorization de todas as demais requisições.
  4. Ao receber 401 Unauthorized, renove o token fazendo login novamente.

Autenticação

Login e emissão do token JWT.

POST/api/Auth/login

Autenticação do usuário. Retorna um token JWT para uso nos demais endpoints.

Corpo da requisição

Schema: Controllers_UserLogin

Campos do corpo 2 campos
CampoTipoNullable
usernamestringSim
passwordstringSim
{
  "username": "string",
  "password": "string"
}

Respostas

200 Success

Schema: LoginResponse

Campos da resposta 1 campo
CampoTipoNullable
tokenstringSim
Exemplo de resposta
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Auth/login" \
  -H "Content-Type: application/json" \
  -d '{"username": "seu_usuario", "password": "sua_senha"}'

Comunicado de Venda

Registro, consulta e cancelamento de comunicados de venda junto ao DETRAN.

POST/api/ComunicadoVenda/cadastrar

Cadastra um novo comunicado de venda de veículo no sistema DETRAN.

Corpo da requisição

Schema: ComunicacaoVendaRequest

Campos do corpo 35 campos
CampoTipoNullable
vendedorTipoPessoastringNão
vendedorCpfstringSim
vendedorCnpjstringSim
vendedorNomestringNão
compradorTipoPessoastringNão
compradorCpfstringSim
compradorCnpjstringSim
compradorNomestringNão
compradorEnderecoCepstringNão
compradorEnderecoLogradourostringNão
compradorEnderecoNumerostringNão
compradorEnderecoBairrostringSim
compradorEnderecoComplementostringSim
compradorEnderecoCidadeinteger (int32)Não
vendaCidadeinteger (int32)Não
vendaDatastringNão
vendaValornumber (double)Não
vendaCompradorSolicitantestringSim
veiculoPlacastringNão
veiculoRenavamstringNão
veiculoAnoFabricacaointeger (int32)Não
veiculoAnoModelointeger (int32)Não
crvNumerostringNão
crvCodigoSegurancastringNão
crvNumeroViainteger (int32)Não
crvDataEmissaostringNão
crvUfEmissaostringNão
arquivosarray<ArquivoCarven>Sim
nomestringSim
bytesstringSim
urlstringSim
tamanhointeger (int32)Não
extensaostringSim
mime_typestringSim
hashstringSim
{
  "vendedorTipoPessoa": "string",
  "vendedorCpf": "string",
  "vendedorCnpj": "string",
  "vendedorNome": "string",
  "compradorTipoPessoa": "string",
  "compradorCpf": "string",
  "compradorCnpj": "string",
  "compradorNome": "string",
  "compradorEnderecoCep": "string",
  "compradorEnderecoLogradouro": "string",
  "compradorEnderecoNumero": "string",
  "compradorEnderecoBairro": "string",
  "compradorEnderecoComplemento": "string",
  "compradorEnderecoCidade": 0,
  "vendaCidade": 0,
  "vendaData": "string",
  "vendaValor": 0,
  "vendaCompradorSolicitante": "string",
  "veiculoPlaca": "string",
  "veiculoRenavam": "string",
  "veiculoAnoFabricacao": 0,
  "veiculoAnoModelo": 0,
  "crvNumero": "string",
  "crvCodigoSeguranca": "string",
  "crvNumeroVia": 0,
  "crvDataEmissao": "string",
  "crvUfEmissao": "string",
  "arquivos": [
    {
      "nome": "string",
      "bytes": "string",
      "url": "string",
      "tamanho": 0,
      "extensao": "string",
      "mime_type": "string",
      "hash": "string"
    }
  ]
}

Respostas

200 Success

Schema: CadastrarComunicadoResponse

Campos da resposta 15 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
categoriastringSim
mensagemstringSim
codigostringSim
protocoloInternostringSim
situacaointeger (int32)Sim
situacaoNomestringSim
dadosobjectNão
protocoloInternostringSim
situacaointeger (int32)Não
situacaoNomestringSim
placastringSim
enviadoEmstring (date-time)Sim
Exemplo de resposta
{
  "sucesso": false,
  "mensagem": "string",
  "erro": {
    "categoria": "string",
    "mensagem": "string",
    "codigo": "string",
    "protocoloInterno": "string",
    "situacao": 0,
    "situacaoNome": "string"
  },
  "dados": {
    "protocoloInterno": "string",
    "situacao": 0,
    "situacaoNome": "string",
    "placa": "string",
    "enviadoEm": "date-time"
  }
}
400 Bad Request

Schema: CadastrarComunicadoResponse

401 Unauthorized

Schema: ProblemDetails

409 Conflict

Schema: CadastrarComunicadoResponse

422 Client Error

Schema: CadastrarComunicadoResponse

423 Client Error

Schema: CadastrarComunicadoResponse

500 Server Error

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/ComunicadoVenda/cadastrar" \
  -H "Authorization: Bearer <SEU_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "vendedorTipoPessoa": "string",
  "vendedorCpf": "string",
  "vendedorCnpj": "string",
  "vendedorNome": "string",
  "compradorTipoPessoa": "string",
  "compradorCpf": "string",
  "compradorCnpj": "string",
  "compradorNome": "string",
  "compradorEnderecoCep": "string",
  "compradorEnderecoLogradouro": "string",
  "compradorEnderecoNumero": "string",
  "compradorEnderecoBairro": "string",
  "compradorEnderecoComplemento": "string",
  "compradorEnderecoCidade": 0,
  "vendaCidade": 0,
  "vendaData": "string",
  "vendaValor": 0,
  "vendaCompradorSolicitante": "string",
  "veiculoPlaca": "string",
  "veiculoRenavam": "string",
  "veiculoAnoFabricacao": 0,
  "veiculoAnoModelo": 0,
  "crvNumero": "string",
  "crvCodigoSeguranca": "string",
  "crvNumeroVia": 0,
  "crvDataEmissao": "string",
  "crvUfEmissao": "string",
  "arquivos": [
    {
      "nome": "string",
      "bytes": "string",
      "url": "string",
      "tamanho": 0,
      "extensao": "string",
      "mime_type": "string",
      "hash": "string"
    }
  ]
}'
GET/api/ComunicadoVenda/detalhar/{protocolo}

Detalha um comunicado de venda a partir do protocolo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
protocolopathstringSimProtocolo do comunicado de venda.

Respostas

200 Success

Schema: DetalharComunicadoResponse

Campos da resposta 61 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
categoriastringSim
mensagemstringSim
codigostringSim
protocoloInternostringSim
situacaointeger (int32)Sim
situacaoNomestringSim
dadosobjectNão
protocoloInternostringSim
placastringSim
renavamstringSim
vendedorDocumentostringSim
compradorDocumentostringSim
situacaointeger (int32)Não
situacaoNomestringSim
cobradobooleanNão
criadoEmstring (date-time)Não
atualizadoEmstring (date-time)Não
enviadoEmstring (date-time)Sim
canceladoEmstring (date-time)Sim
podeSerAlteradobooleanNão
podeSerCanceladobooleanNão
detalhesobjectNão
vendedorobjectNão
tipoPessoastringSim
cpfstringSim
cnpjstringSim
nomestringSim
compradorobjectNão
tipoPessoastringSim
cpfstringSim
cnpjstringSim
nomestringSim
enderecoobjectNão
cepstringSim
logradourostringSim
numerostringSim
bairrostringSim
complementostringSim
cidadeinteger (int32)Sim
vendaobjectNão
cidadeinteger (int32)Sim
datastringSim
valornumber (double)Sim
compradorSolicitantestringSim
veiculoobjectNão
placastringSim
renavamstringSim
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
crvobjectNão
numerostringSim
codigoSegurancastringSim
numeroViainteger (int32)Sim
dataEmissaostringSim
ufEmissaostringSim
situacaoobjectNão
codigointeger (int32)Não
nomestringSim
Exemplo de resposta
{
  "sucesso": false,
  "mensagem": "string",
  "erro": {
    "categoria": "string",
    "mensagem": "string",
    "codigo": "string",
    "protocoloInterno": "string",
    "situacao": 0,
    "situacaoNome": "string"
  },
  "dados": {
    "protocoloInterno": "string",
    "placa": "string",
    "renavam": "string",
    "vendedorDocumento": "string",
    "compradorDocumento": "string",
    "situacao": 0,
    "situacaoNome": "string",
    "cobrado": false,
    "criadoEm": "date-time",
    "atualizadoEm": "date-time",
    "enviadoEm": "date-time",
    "canceladoEm": "date-time",
    "podeSerAlterado": false,
    "podeSerCancelado": false,
    "detalhes": {
      "vendedor": {
        "tipoPessoa": "string",
        "cpf": "string",
        "cnpj": "string",
        "nome": "string"
      },
      "comprador": {
        "tipoPessoa": "string",
        "cpf": "string",
        "cnpj": "string",
        "nome": "string",
        "endereco": {
          "cep": "string",
          "logradouro": "string",
          "numero": "string",
          "bairro": "string",
          "complemento": "string",
          "cidade": 0
        }
      },
      "venda": {
        "cidade": 0,
        "data": "string",
        "valor": 0,
        "compradorSolicitante": "string"
      },
      "veiculo": {
        "placa": "string",
        "renavam": "string",
        "anoFabricacao": 0,
        "anoModelo": 0,
        "crv": {
          "numero": "string",
          "codigoSeguranca": "string",
          "numeroVia": 0,
          "dataEmissao": "string",
          "ufEmissao": "string"
        }
      },
      "situacao": {
        "codigo": 0,
        "nome": "string"
      }
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

404 Not Found

Schema: DetalharComunicadoResponse

500 Server Error

Exemplo cURL

curl -X GET "https://api.avaliservice.com.br/api/ComunicadoVenda/detalhar/PROTOCOLO" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/ComunicadoVenda/cancelar/{protocolo}

Cancela um comunicado de venda a partir do protocolo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
protocolopathstringSimProtocolo do comunicado de venda.

Corpo da requisição

Schema: CancelarComunicacaoRequest

Campos do corpo 1 campo
CampoTipoNullable
id_motivo_cancelamentointeger (int32)Não
{
  "id_motivo_cancelamento": 0
}

Respostas

200 Success

Schema: CancelarComunicadoResponse

Campos da resposta 14 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
categoriastringSim
mensagemstringSim
codigostringSim
protocoloInternostringSim
situacaointeger (int32)Sim
situacaoNomestringSim
dadosobjectNão
protocoloInternostringSim
situacaointeger (int32)Não
situacaoNomestringSim
canceladoEmstring (date-time)Sim
Exemplo de resposta
{
  "sucesso": false,
  "mensagem": "string",
  "erro": {
    "categoria": "string",
    "mensagem": "string",
    "codigo": "string",
    "protocoloInterno": "string",
    "situacao": 0,
    "situacaoNome": "string"
  },
  "dados": {
    "protocoloInterno": "string",
    "situacao": 0,
    "situacaoNome": "string",
    "canceladoEm": "date-time"
  }
}
400 Bad Request

Schema: CancelarComunicadoResponse

401 Unauthorized

Schema: ProblemDetails

404 Not Found

Schema: CancelarComunicadoResponse

500 Server Error

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/ComunicadoVenda/cancelar/PROTOCOLO" \
  -H "Authorization: Bearer <SEU_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"id_motivo_cancelamento": 0}'
GET/api/ComunicadoVenda/listar

Lista todos os comunicados de venda registrados, com filtros opcionais.

Parâmetros

NomeOndeTipoObrigatórioDescrição
statusquerystringNãoFiltro por status do comunicado.
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.
dataInicioquerystringNãoData inicial para filtro (formato: AAAA-MM-DDTHH:mm:ss).
dataFimquerystringNãoData final para filtro (formato: AAAA-MM-DDTHH:mm:ss).
limitequeryintegerNãoQuantidade máxima de registros retornados (padrão: 20).

Respostas

200 Success

Schema: ListarComunicadosResponse

Campos da resposta 18 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
categoriastringSim
mensagemstringSim
codigostringSim
protocoloInternostringSim
situacaointeger (int32)Sim
situacaoNomestringSim
totalinteger (int32)Não
dadosarray<ComunicadoListItem>Sim
protocoloInternostringSim
placastringSim
situacaointeger (int32)Não
situacaoNomestringSim
cobradobooleanNão
criadoEmstring (date-time)Não
enviadoEmstring (date-time)Sim
Exemplo de resposta
{
  "total": 0,
  "dados": [],
  "sucesso": true,
  "mensagem": null,
  "erro": null
}
401 Unauthorized

Schema: ProblemDetails

500 Server Error

Exemplo cURL

curl -X GET "https://api.avaliservice.com.br/api/ComunicadoVenda/listar?status=VALOR&placa=VALOR&dataInicio=VALOR&dataFim=VALOR&limite=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Veículo — cadastro e situação

Bases BIN e estaduais, dados cadastrais, ficha técnica, valoração e histórico.

POST/api/Consultas/binnacional

Consulta da Base de Índice Nacional (BIN) — dados completos do veículo no âmbito federal.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewNacional

Campos da resposta 71 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
placaMercosulstringSim
chassistringSim
renavamstringSim
chassiRemarcadostringSim
ultimaAtualizacaostringSim
municipiostringSim
ufstringSim
procedenciastringSim
tipostringSim
especiestringSim
tipoMontagemstringSim
marcaModelostringSim
anoModstringSim
anoFabstringSim
capPassagstringSim
corstringSim
potenciastringSim
cilindradasstringSim
carroceriastringSim
combustivelstringSim
cmtstringSim
pbtstringSim
eixosstringSim
nEixoAuxiliarstringSim
nEixoTraseirostringSim
nMotorstringSim
nCambiostringSim
situacaoVeiculostringSim
rfAtivostringSim
multaRENAINFstringSim
recallstringSim
restricaoRFBstringSim
indicadorSinistrostringSim
comunicadodeVendastringSim
pendenciaEmissaoDocumentostringSim
restricaoRENAJUDstringSim
nDocumentoProprietariostringSim
tipoDocumentoProprietariostringSim
nomeProprietariostringSim
nDocumentoFaturadostringSim
tipoDocumentoFaturadostringSim
ufFaturamentostringSim
categoriastringSim
dataAtualizacaostringSim
dataEmplacamentostringSim
capacidadeCargastringSim
numeroEixoTraseiroDiferencialstringSim
numeroTerceiroEixostringSim
tipoDocumentoImportadorastringSim
dataLimiteRestricaostringSim
numeroDistringSim
restricaoTipoTransacaostringSim
restricoesRestricaoFinanstringSim
restricaoNomeAgentestringSim
restricaoFinanciadostringSim
restricaoCpfCnpjFinanciadostringSim
restricaoDataInclusaostringSim
restricaoUmstringSim
restricaoDoisstringSim
restricaoTresstringSim
restricaoQuatrostringSim
restricoesAdicionaisstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "0d21d782-9438-4fdd-99fc-5d2d4d879017",
    "dataConsulta": "25/06/2026 15:01:43",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Nacional",
    "tempoTotalMs": 0
  },
  "retorno": {
    "Placa": "ABC1D23",
    "PlacaMercosul": "ABC1D23",
    "Chassi": "XXXXXXXXXXXXXXXXX",
    "Renavam": "00000000000",
    "ChassiRemarcado": "XXXXXXXXXXXXXXXXX",
    "UltimaAtualizacao": "14/02/1995",
    "Municipio": "CURITIBA",
    "UF": "PR",
    "Procedencia": "NACIONAL",
    "Tipo": "AUTOMOVEL",
    "Especie": "PASSAGEIRO",
    "TipoMontagem": "NAO INFORMADO",
    "MarcaModelo": "VW/PASSAT TS",
    "AnoMod": "1979",
    "AnoFab": "1979",
    "CapPassag": "5",
    "Cor": "AZUL",
    "Potencia": "78",
    "Cilindradas": "0",
    "Carroceria": "",
    "Combustivel": "GASOLINA",
    "CMT": "0",
    "PBT": "0",
    "Eixos": "0",
    "NEixoAuxiliar": "",
    "NEixoTraseiro": "",
    "NMotor": "",
    "NCambio": "",
    "SituacaoVeiculo": "EM CIRCULACAO",
    "RfAtivo": "NAO",
    "MultaRENAINF": "NAO",
    "Recall": "NAO",
    "RestricaoRFB": "NAO",
    "indicadorSinistro": "NAO",
    "ComunicadodeVenda": "NAO",
    "PendenciaEmissaoDocumento": "NAO",
    "RestricaoRENAJUD": "NAO",
    "NDocumentoProprietario": "00000000000",
    "TipoDocumentoProprietario": "CPF",
    "NomeProprietario": "NOME PROTEGIDO",
    "NDocumentoFaturado": "",
    "TipoDocumentoFaturado": "",
    "UfFaturamento": "",
    "Categoria": "PARTICULAR",
    "DataAtualizacao": "14/02/1995",
    "DataEmplacamento": "",
    "CapacidadeCarga": "0",
    "NumeroEixoTraseiroDiferencial": "NAO INFORMADO",
    "NumeroTerceiroEixo": "NAO INFORMADO",
    "TipoDocumentoImportadora": "",
    "DataLimiteRestricao": "",
    "NumeroDi": "",
    "RestricaoTipoTransacao": "",
    "RestricoesRestricaoFinan": "",
    "RestricaoNomeAgente": "",
    "RestricaoFinanciado": "",
    "RestricaoCpfCnpjFinanciado": "",
    "RestricaoDataInclusao": "",
    "RestricaoUm": "NADA CONSTA",
    "RestricaoDois": "NADA CONSTA",
    "RestricaoTres": "NADA CONSTA",
    "RestricaoQuatro": "NADA CONSTA",
    "RestricoesAdicionais": ""
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/binnacional?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/binnacional2

Consulta da Base de Índice Nacional (BIN, base alternativa).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).
tipoquerystringNãoPreencher com 'motor' para pesquisa via número do motor. Se omitido, aceita placa ou chassi por padrão.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewNacional2

Campos da resposta 59 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
chassistringSim
renavamstringSim
chassiRemarcadostringSim
municipiostringSim
ufstringSim
procedenciastringSim
tipostringSim
especiestringSim
marcaModelostringSim
codigoMarcaModelostringSim
anoModstringSim
anoFabstringSim
capPassagstringSim
corstringSim
potenciastringSim
cilindradasstringSim
carroceriastringSim
combustivelstringSim
cmtstringSim
pbtstringSim
capacidadeCargastringSim
eixosstringSim
nEixoAuxiliarstringSim
nEixoTraseirostringSim
nMotorstringSim
nCambiostringSim
situacaoVeiculostringSim
rfAtivostringSim
multaRENAINFstringSim
recallstringSim
restricaoRFBstringSim
comunicadodeVendastringSim
pendenciaEmissaoDocumentostringSim
restricaoRENAJUDstringSim
nDocumentoProprietariostringSim
tipoDocumentoProprietariostringSim
nomeProprietariostringSim
nDocumentoFaturadostringSim
tipoDocumentoFaturadostringSim
categoriastringSim
dataEmissaoCRVstringSim
dataEmissaoCRLVstringSim
anoLicenciamentoPagostringSim
numeroCarroceriastringSim
numeroDistringSim
restricaoUmstringSim
restricaoDoisstringSim
restricaoTresstringSim
restricaoQuatrostringSim
restricoesAdicionaisstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "5b763fb7-9fd1-431c-860d-5c9f4aef10b6",
    "dataConsulta": "25/06/2026 15:01:47",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Nacional 2",
    "tempoTotalMs": 4276
  },
  "retorno": {
    "Placa": "ABC1D23",
    "Chassi": "XXXXXXXXXXXXXXXXX",
    "Renavam": "00000000000",
    "ChassiRemarcado": "XXXXXXXXXXXXXXXXX",
    "Municipio": "CURITIBA",
    "UF": "PR",
    "Procedencia": "NACIONAL",
    "Tipo": "AUTOMOVEL",
    "Especie": "PASSAGEIRO",
    "MarcaModelo": "VW/PASSAT TS",
    "CodigoMarcaModelo": "116717",
    "AnoMod": "1979",
    "AnoFab": "1979",
    "CapPassag": "5",
    "Cor": "AZUL",
    "Potencia": "78",
    "Cilindradas": "0",
    "Carroceria": "",
    "Combustivel": "GASOLINA",
    "CMT": "0",
    "PBT": "0",
    "CapacidadeCarga": "0",
    "Eixos": "0",
    "NEixoAuxiliar": "",
    "NEixoTraseiro": "",
    "NMotor": "",
    "NCambio": "",
    "SituacaoVeiculo": "EM CIRCULACAO",
    "RfAtivo": "NAO",
    "MultaRENAINF": "NAO",
    "Recall": "NAO",
    "RestricaoRFB": "NAO",
    "ComunicadodeVenda": "NAO",
    "PendenciaEmissaoDocumento": "NAO",
    "RestricaoRENAJUD": "NAO",
    "NDocumentoProprietario": "00000000000",
    "TipoDocumentoProprietario": "CPF",
    "NomeProprietario": "NOME PROTEGIDO",
    "NDocumentoFaturado": "",
    "TipoDocumentoFaturado": "",
    "Categoria": "PARTICULAR",
    "DataEmissaoCRV": "14/02/1995",
    "DataEmissaoCRLV": "",
    "AnoLicenciamentoPago": null,
    "NumeroCarroceria": "",
    "NumeroDi": "",
    "RestricaoUm": "NADA CONSTA",
    "RestricaoDois": "NADA CONSTA",
    "RestricaoTres": "NADA CONSTA",
    "RestricaoQuatro": "NADA CONSTA",
    "RestricoesAdicionais": ""
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/binnacional2?parametro=VALOR&tipo=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/binestadual

Consulta estadual do veículo — dados de registro, débitos, restrições e proprietário.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewEstadual

Campos da resposta 58 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
situacaoVeiculostringSim
placastringSim
municipiostringSim
ufstringSim
renavamstringSim
cpfCnpjProprietariostringSim
tipoDocumentoProprietariostringSim
pronomestringSim
propAntestringSim
licDatastringSim
dataEmissaoCrvstringSim
chassistringSim
tipoDocumentoFaturadostringSim
cpfCnpjFaturadostringSim
ufFaturadostringSim
tipoRemarcacaoChassistringSim
marcaModeloCompletostringSim
marcastringSim
modelostringSim
veiculoAnoFabricacaostringSim
veiculoAnoModelostringSim
tipostringSim
carroceriastringSim
corstringSim
especiestringSim
categoriaVeiculostringSim
combustivelstringSim
potenciastringSim
cilindradastringSim
capacidadeCargastringSim
veiculoProcedenciastringSim
capacidadePassageirosstringSim
comunicadoVendastringSim
numeroCambiostringSim
motorstringSim
cmtstringSim
pbtstringSim
eixosstringSim
existeDebitoDeIpvastringSim
existeDebitoMultastringSim
debitoIpvastringSim
existeDebitoLicenciamentostringSim
existeDebitoLicenciamentoValorstringSim
valorTotalDebitoMultastringSim
existeDebitoDpvatstringSim
dpvatstringSim
outrasRestricoesUmstringSim
outrasRestricoesDoisstringSim
outrasRestricoesTresstringSim
outrasRestricoesQuatrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "situacaoVeiculo": "string",
    "placa": "string",
    "municipio": "string",
    "uf": "string",
    "renavam": "string",
    "cpfCnpjProprietario": "string",
    "tipoDocumentoProprietario": "string",
    "pronome": "string",
    "propAnte": "string",
    "licData": "string",
    "dataEmissaoCrv": "string",
    "chassi": "string",
    "tipoDocumentoFaturado": "string",
    "cpfCnpjFaturado": "string",
    "ufFaturado": "string",
    "tipoRemarcacaoChassi": "string",
    "marcaModeloCompleto": "string",
    "marca": "string",
    "modelo": "string",
    "veiculoAnoFabricacao": "string",
    "veiculoAnoModelo": "string",
    "tipo": "string",
    "carroceria": "string",
    "cor": "string",
    "especie": "string",
    "categoriaVeiculo": "string",
    "combustivel": "string",
    "potencia": "string",
    "cilindrada": "string",
    "capacidadeCarga": "string",
    "veiculoProcedencia": "string",
    "capacidadePassageiros": "string",
    "comunicadoVenda": "string",
    "numeroCambio": "string",
    "motor": "string",
    "cmt": "string",
    "pbt": "string",
    "eixos": "string",
    "existeDebitoDeIpva": "string",
    "existeDebitoMulta": "string",
    "debitoIpva": "string",
    "existeDebitoLicenciamento": "string",
    "existeDebitoLicenciamentoValor": "string",
    "valorTotalDebitoMulta": "string",
    "existeDebitoDpvat": "string",
    "dpvat": "string",
    "outrasRestricoesUm": "string",
    "outrasRestricoesDois": "string",
    "outrasRestricoesTres": "string",
    "outrasRestricoesQuatro": "string"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/binestadual?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/estadual2

Consulta estadual do veículo (base alternativa) — dados de registro, débitos e restrições.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewEstadual

Campos da resposta 58 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
situacaoVeiculostringSim
placastringSim
municipiostringSim
ufstringSim
renavamstringSim
cpfCnpjProprietariostringSim
tipoDocumentoProprietariostringSim
pronomestringSim
propAntestringSim
licDatastringSim
dataEmissaoCrvstringSim
chassistringSim
tipoDocumentoFaturadostringSim
cpfCnpjFaturadostringSim
ufFaturadostringSim
tipoRemarcacaoChassistringSim
marcaModeloCompletostringSim
marcastringSim
modelostringSim
veiculoAnoFabricacaostringSim
veiculoAnoModelostringSim
tipostringSim
carroceriastringSim
corstringSim
especiestringSim
categoriaVeiculostringSim
combustivelstringSim
potenciastringSim
cilindradastringSim
capacidadeCargastringSim
veiculoProcedenciastringSim
capacidadePassageirosstringSim
comunicadoVendastringSim
numeroCambiostringSim
motorstringSim
cmtstringSim
pbtstringSim
eixosstringSim
existeDebitoDeIpvastringSim
existeDebitoMultastringSim
debitoIpvastringSim
existeDebitoLicenciamentostringSim
existeDebitoLicenciamentoValorstringSim
valorTotalDebitoMultastringSim
existeDebitoDpvatstringSim
dpvatstringSim
outrasRestricoesUmstringSim
outrasRestricoesDoisstringSim
outrasRestricoesTresstringSim
outrasRestricoesQuatrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "situacaoVeiculo": "string",
    "placa": "string",
    "municipio": "string",
    "uf": "string",
    "renavam": "string",
    "cpfCnpjProprietario": "string",
    "tipoDocumentoProprietario": "string",
    "pronome": "string",
    "propAnte": "string",
    "licData": "string",
    "dataEmissaoCrv": "string",
    "chassi": "string",
    "tipoDocumentoFaturado": "string",
    "cpfCnpjFaturado": "string",
    "ufFaturado": "string",
    "tipoRemarcacaoChassi": "string",
    "marcaModeloCompleto": "string",
    "marca": "string",
    "modelo": "string",
    "veiculoAnoFabricacao": "string",
    "veiculoAnoModelo": "string",
    "tipo": "string",
    "carroceria": "string",
    "cor": "string",
    "especie": "string",
    "categoriaVeiculo": "string",
    "combustivel": "string",
    "potencia": "string",
    "cilindrada": "string",
    "capacidadeCarga": "string",
    "veiculoProcedencia": "string",
    "capacidadePassageiros": "string",
    "comunicadoVenda": "string",
    "numeroCambio": "string",
    "motor": "string",
    "cmt": "string",
    "pbt": "string",
    "eixos": "string",
    "existeDebitoDeIpva": "string",
    "existeDebitoMulta": "string",
    "debitoIpva": "string",
    "existeDebitoLicenciamento": "string",
    "existeDebitoLicenciamentoValor": "string",
    "valorTotalDebitoMulta": "string",
    "existeDebitoDpvat": "string",
    "dpvat": "string",
    "outrasRestricoesUm": "string",
    "outrasRestricoesDois": "string",
    "outrasRestricoesTres": "string",
    "outrasRestricoesQuatro": "string"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/estadual2?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/Agregados

Consulta dados de agregados (número de motor e câmbio) do veículo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewAgregados

Campos da resposta 27 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
ufPlacastringSim
chassistringSim
marcaModelostringSim
tipostringSim
combustivelstringSim
corstringSim
renavamstringSim
nrMotorstringSim
nrCambiostringSim
situacaoVeiculostringSim
municipiostringSim
especiestringSim
procedenciaVeiculostringSim
capacidadeDePassageirosstringSim
cilindradastringSim
capacidadeCargastringSim
ufDestFaturadostringSim
dataUltimaAtualizacaostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "569517ad-adab-4b6d-ba48-cf142e01a000",
    "dataConsulta": "25/06/2026 14:59:25",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Agregados",
    "tempoTotalMs": 24272
  },
  "retorno": {
    "placa": "ABC1D23",
    "ufPlaca": null,
    "chassi": "XXXXXXXXXXXXXXXXX",
    "marcaModelo": "VW/PASSAT TS",
    "tipo": "AUTOMOVEL",
    "combustivel": "GASOLINA",
    "cor": "AZUL",
    "renavam": null,
    "nrMotor": null,
    "nrCambio": null,
    "situacaoVeiculo": null,
    "municipio": null,
    "especie": "PASSAGEIRO",
    "procedenciaVeiculo": "NACIONAL",
    "capacidadeDePassageiros": "5",
    "cilindrada": "0",
    "capacidadeCarga": "0.0",
    "ufDestFaturado": null,
    "dataUltimaAtualizacao": "2026-06-25T17:58:47.2193371Z"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/Agregados?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/csv

Consulta CSV — dados cadastrais do veículo via SENATRAN.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCSV

Campos da resposta 109 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
cmcnumber (double)Sim
cmtnumber (double)Sim
tipoCarroceriaCodigostringSim
tipoCarroceriaDescricaostringSim
categoriaDescricaostringSim
chassiSeriestringSim
cilindradasinteger (int32)Sim
combustivelCodigostringSim
combustivelDescricaostringSim
corCodigostringSim
corDescricaostringSim
especieDescricaostringSim
indicadorAlarmebooleanSim
indicadorRouboFurtobooleanSim
lotacaointeger (int32)Sim
marcaModeloCodigostringSim
marcaModeloDescricaostringSim
municipioEmplacamentoCodigostringSim
municipioEmplacamentoDescricaostringSim
qtdEixosinteger (int32)Sim
pbtnumber (double)Sim
potenciainteger (int32)Sim
numeroIdentificacaoProprietariostringSim
situacaostringSim
tipoVeiculoCodigostringSim
tipoVeiculoDescricaostringSim
ufJurisdicaostringSim
indicadorComunicacaoVendabooleanSim
indicadorLeilaobooleanSim
indicadorMultaRenainfbooleanSim
indicadorPendenciaEmissaobooleanSim
indicadorRecall1booleanSim
indicadorRecall2booleanSim
indicadorRecall3booleanSim
indicadorRecallMontadorabooleanSim
restricao1CodigostringSim
restricao1DescricaostringSim
restricao2CodigostringSim
restricao2DescricaostringSim
restricao3CodigostringSim
restricao3DescricaostringSim
restricao4CodigostringSim
restricao4DescricaostringSim
indicadorRestricaoRenajudbooleanSim
restricaoRfbIndicadorstringSim
restricaoRfbDescricaostringSim
procedenciastringSim
indicadorOstentaPIVbooleanSim
tipoArrendatarioCodigostringSim
tipoArrendatarioDescricaostringSim
numeroCarroceriastringSim
remarcacaoChassiCodigostringSim
remarcacaoChassiDescricaostringSim
dataEmissaoCrvstringSim
dataUltimaAtualizacaostringSim
orgaoRfbCodigostringSim
orgaoRfbDescricaostringSim
numeroEixoAuxiliarstringSim
numeroEixoTraseirostringSim
naturezaFaturadostringSim
ufFaturadostringSim
naturezaImportadorstringSim
descricaoDocImportadorstringSim
paisTransferenciaCodigostringSim
paisTransferenciaDescricaostringSim
docProprietarioIndicadoTipostringSim
docProprietarioIndicadoDescricaostringSim
tipoProprietarioCodigostringSim
tipoProprietarioDescricaostringSim
nomeArrendatariostringSim
numeroIdentificacaoArrendatariostringSim
numeroCambiostringSim
chassistringSim
numeroDeclaracaoImportacaostringSim
numeroIdFaturamentostringSim
numeroIdImportadorstringSim
numeroMotorstringSim
placastringSim
possuidorNomestringSim
possuidorNumeroDocumentostringSim
possuidorOrigemstringSim
numeroDocProprietarioIndicadostringSim
nomeProprietariostringSim
registroAduaneirostringSim
codigoRenavamstringSim
usuarioEhPossuidorbooleanSim
usuarioEhPrincipalCondutorbooleanSim
usuarioFoiPrincipalCondutorbooleanSim
listaCsvarray<string>Sim
permiteBaixarCrvlDigitalbooleanSim
recallQuantidadeinteger (int32)Sim
recallQuantidadeRealinteger (int32)Sim
recallsarray<RecallItem>Sim
nomeRecallstringSim
descricaoRecallstringSim
dataRegistrostringSim
dataRegistroFormatadastringSim
laudosarray<string>Sim
pdfBase64stringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "fc3cec05-ad5f-4a56-bd41-c43712449863",
    "dataConsulta": "25/06/2026 15:02:43",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "csv",
    "tempoTotalMs": 65
  },
  "retorno": {
    "anoFabricacao": null,
    "anoModelo": null,
    "cmc": null,
    "cmt": null,
    "tipoCarroceriaCodigo": null,
    "tipoCarroceriaDescricao": null,
    "categoriaDescricao": null,
    "chassiSerie": null,
    "cilindradas": null,
    "combustivelCodigo": null,
    "combustivelDescricao": null,
    "corCodigo": null,
    "corDescricao": null,
    "especieDescricao": null,
    "indicadorAlarme": null,
    "indicadorRouboFurto": null,
    "lotacao": null,
    "marcaModeloCodigo": null,
    "marcaModeloDescricao": null,
    "municipioEmplacamentoCodigo": null,
    "municipioEmplacamentoDescricao": null,
    "qtdEixos": null,
    "pbt": null,
    "potencia": null,
    "numeroIdentificacaoProprietario": null,
    "situacao": null,
    "tipoVeiculoCodigo": null,
    "tipoVeiculoDescricao": null,
    "ufJurisdicao": null,
    "indicadorComunicacaoVenda": null,
    "indicadorLeilao": null,
    "indicadorMultaRenainf": null,
    "indicadorPendenciaEmissao": null,
    "indicadorRecall1": null,
    "indicadorRecall2": null,
    "indicadorRecall3": null,
    "indicadorRecallMontadora": null,
    "restricao1Codigo": null,
    "restricao1Descricao": null,
    "restricao2Codigo": null,
    "restricao2Descricao": null,
    "restricao3Codigo": null,
    "restricao3Descricao": null,
    "restricao4Codigo": null,
    "restricao4Descricao": null,
    "indicadorRestricaoRenajud": null,
    "restricaoRfbIndicador": null,
    "restricaoRfbDescricao": null,
    "procedencia": null,
    "indicadorOstentaPIV": null,
    "tipoArrendatarioCodigo": null,
    "tipoArrendatarioDescricao": null,
    "numeroCarroceria": null,
    "remarcacaoChassiCodigo": null,
    "remarcacaoChassiDescricao": null,
    "dataEmissaoCrv": null,
    "dataUltimaAtualizacao": null,
    "orgaoRfbCodigo": null,
    "orgaoRfbDescricao": null,
    "numeroEixoAuxiliar": null,
    "numeroEixoTraseiro": null,
    "naturezaFaturado": null,
    "ufFaturado": null,
    "naturezaImportador": null,
    "descricaoDocImportador": null,
    "paisTransferenciaCodigo": null,
    "paisTransferenciaDescricao": null,
    "docProprietarioIndicadoTipo": null,
    "docProprietarioIndicadoDescricao": null,
    "tipoProprietarioCodigo": null,
    "tipoProprietarioDescricao": null,
    "nomeArrendatario": null,
    "numeroIdentificacaoArrendatario": null,
    "numeroCambio": null,
    "chassi": null,
    "numeroDeclaracaoImportacao": null,
    "numeroIdFaturamento": null,
    "numeroIdImportador": null,
    "numeroMotor": null,
    "placa": null,
    "possuidorNome": null,
    "possuidorNumeroDocumento": null,
    "possuidorOrigem": null,
    "numeroDocProprietarioIndicado": null,
    "nomeProprietario": null,
    "registroAduaneiro": null,
    "codigoRenavam": null,
    "usuarioEhPossuidor": null,
    "usuarioEhPrincipalCondutor": null,
    "usuarioFoiPrincipalCondutor": null,
    "listaCsv": null,
    "permiteBaixarCrvlDigital": null,
    "recallQuantidade": null,
    "recallQuantidadeReal": null,
    "recalls": null,
    "laudos": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/csv?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/csv2

Consulta CSV (base alternativa) — dados cadastrais do veículo, incluindo nome do proprietário.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCSVPrime

Campos da resposta 108 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
chassistringSim
placastringSim
renavamstringSim
marcaModelostringSim
corVeiculostringSim
anoModelostringSim
anoFabricacaostringSim
combustivelstringSim
motorstringSim
ufstringSim
municipiostringSim
dataAtualizacaostringSim
crlvstringSim
proprietarioNomestringSim
proprietarioDocumentostringSim
binNacionalobjectNão
situacaostringSim
situacaoChassistringSim
tipoVeiculostringSim
especieVeiculostringSim
tipoCarroceriastringSim
potenciaVeiculostringSim
cmtstringSim
pbtstringSim
capacidadeCargastringSim
procedenciastringSim
categoriaVeiculostringSim
quantidadePassageirosstringSim
numeroEixosstringSim
dataEmissaoCrlvstringSim
dataEmissaoUltimoCrvstringSim
restricoesobjectNão
existeRestricaoRouboFurtostringSim
veiculoBaixadostringSim
existeRestricaoRenajudstringSim
existeRestricaoGeralstringSim
mensagensRestricoesarray<string>Sim
precificadorarray<PrecificadorView>Sim
fabricanteModelostringSim
anoModelostringSim
combustivelstringSim
informantestringSim
codigostringSim
vigenciastringSim
precostringSim
precoMediostringSim
quantidadeAlertasstringSim
alertasarray<AlertaView>Sim
severidadestringSim
mensagemstringSim
descricaostringSim
renajudobjectNão
quantidadeOcorrenciasstringSim
msgAlertastringSim
recallobjectNão
quantidadeOcorrenciasstringSim
ocorrenciasarray<RecallOcorrenciaView>Sim
codigoRecallstringSim
descricaoRecallstringSim
dataIniciostringSim
dataFimstringSim
csvobjectNão
quantidadeOcorrenciastringSim
mensagemObservacaostringSim
renainfobjectNão
qtdOcorrenciasstringSim
fichaTecnicaobjectNão
cambiostringSim
direcaostringSim
freioDianteirostringSim
freioTraseirostringSim
motorDescricaostringSim
quantidadePassageirosstringSim
quantidadePortasstringSim
suspensaoDianteirastringSim
suspensaoTraseirastringSim
tipoTracaostringSim
medidasobjectNão
alturastringSim
largurastringSim
comprimentostringSim
entreEixosstringSim
pesostringSim
portaMalasstringSim
tanqueCombustivelstringSim
medicaoCombustivelarray<MedicaoCombustivelView>Sim
combustivelstringSim
potenciastringSim
cilindradasstringSim
torquestringSim
velocidadeMaximastringSim
tempoZeroACemstringSim
consumoCidadestringSim
consumoEstradastringSim
equipamentosarray<EquipamentoView>Sim
descricaostringSim
disponibilidadestringSim
alertaIndicioobjectNão
existeOcorrenciastringSim
descricaoOcorrenciastringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "cfc78056-8619-497d-8852-59596a36756a",
    "dataConsulta": "25/06/2026 14:59:54",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "csv2",
    "tempoTotalMs": 9692
  },
  "retorno": {
    "chassi": "",
    "placa": "",
    "renavam": "",
    "marcaModelo": "",
    "corVeiculo": "",
    "anoModelo": "",
    "anoFabricacao": "",
    "combustivel": "",
    "motor": "",
    "uf": "",
    "municipio": "",
    "dataAtualizacao": "",
    "crlv": "",
    "proprietarioNome": "",
    "proprietarioDocumento": "",
    "binNacional": {
      "situacao": null,
      "situacaoChassi": null,
      "tipoVeiculo": null,
      "especieVeiculo": null,
      "tipoCarroceria": null,
      "potenciaVeiculo": null,
      "cmt": null,
      "pbt": null,
      "capacidadeCarga": null,
      "procedencia": null,
      "categoriaVeiculo": null,
      "quantidadePassageiros": null,
      "numeroEixos": null,
      "dataEmissaoCrlv": null,
      "dataEmissaoUltimoCrv": null,
      "restricoes": null
    },
    "precificador": [],
    "quantidadeAlertas": "0",
    "alertas": [],
    "renajud": {
      "quantidadeOcorrencias": null,
      "msgAlerta": null
    },
    "recall": {
      "quantidadeOcorrencias": null,
      "ocorrencias": null
    },
    "csv": {
      "quantidadeOcorrencia": "0",
      "mensagemObservacao": ""
    },
    "renainf": {
      "qtdOcorrencias": null
    },
    "fichaTecnica": {
      "cambio": null,
      "direcao": null,
      "freioDianteiro": null,
      "freioTraseiro": null,
      "motorDescricao": null,
      "quantidadePassageiros": null,
      "quantidadePortas": null,
      "suspensaoDianteira": null,
      "suspensaoTraseira": null,
      "tipoTracao": null,
      "medidas": null,
      "medicaoCombustivel": null,
      "equipamentos": null
    },
    "alertaIndicio": {
      "existeOcorrencia": null,
      "descricaoOcorrencia": null
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/csv2?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/veiculoDoc

Consulta a frota de um CPF ou CNPJ — retorna até 20 veículos detalhados e o campo com o tamanho total da frota.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoCPF (11 dígitos) ou CNPJ (14 dígitos), somente números. 11 (CPF) ou 14 (CNPJ) dígitos, somente números.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewProprietario

Campos da resposta 22 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
codigointeger (int32)Não
mensagemstringSim
qtdVeiculosinteger (int32)Não
veiculosarray<Models_RetornoViews_VeiculoRegistro>Sim
modelostringSim
placastringSim
renavamstringSim
chassistringSim
estadostringSim
corstringSim
anoFabricacaostringSim
motorstringSim
anoModelostringSim
especiestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "codigo": 0,
    "mensagem": "string",
    "qtdVeiculos": 0,
    "veiculos": [
      {
        "modelo": "string",
        "placa": "string",
        "renavam": "string",
        "chassi": "string",
        "estado": "string",
        "cor": "string",
        "anoFabricacao": "string",
        "motor": "string",
        "anoModelo": "string",
        "especie": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/veiculoDoc?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/decodificador

Decodifica o chassi do veículo, retornando marca, modelo, versão e histórico FIPE.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDecodificador

Campos da resposta 42 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
dsChassistringSim
dsChassiTratadostringSim
dsOrigemstringSim
dsRegiaostringSim
dsPaisstringSim
dsCategoriastringSim
dsMarcastringSim
dsModelostringSim
dsVersaostringSim
nuAnoModelointeger (int32)Sim
dsTipoCarroceriastringSim
dsMotorstringSim
nuCdCombustivelinteger (int32)Sim
dsCombustivelstringSim
dsLocalFabricacaostringSim
precificadorIHistFipearray<PrecificadorIHistFipeView>Sim
dsCodigostringSim
nuValornumber (double)Não
dsMarcastringSim
dsModelostringSim
dsCombustivelstringSim
mesRefFipeZeroKMstringSim
nuValorZeroKMnumber (double)Não
historio12Mesesarray<Historico12MesesView>Sim
idinteger (int32)Não
anoMesstringSim
valorstringSim
precificadorIIarray<PrecificadorIIView>Sim
dsCodigostringSim
dsMarcastringSim
dsModelostringSim
dsVersaostringSim
dsCombustivelstringSim
dsNuValorstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "2107e23f-6d9f-44dc-b4c5-1285291ff443",
    "dataConsulta": "25/06/2026 15:02:49",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "decodificador",
    "tempoTotalMs": 294
  },
  "retorno": {
    "dsChassi": "XXXXXXXXXXXXXXXXX",
    "dsChassiTratado": "XXXXXXXXXXXXXXXXX",
    "dsOrigem": null,
    "dsRegiao": null,
    "dsPais": null,
    "dsCategoria": "AUTOMOVEL",
    "dsMarca": "VOLKSWAGEN",
    "dsModelo": "PASSAT TS",
    "dsVersao": "TS",
    "nuAnoModelo": 1979,
    "dsTipoCarroceria": "SEDAN",
    "dsMotor": null,
    "nuCdCombustivel": 2,
    "dsCombustivel": "G",
    "dsLocalFabricacao": null,
    "precificadorIHistFipe": null,
    "precificadorII": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/decodificador?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/fipe

Consulta a tabela FIPE do veículo — registros de valoração.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewFipe

Campos da resposta 19 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
registrosarray<FipeView>Sim
statusstringSim
chassistringSim
codigoFipestringSim
fabricantestringSim
modelostringSim
anoModelostringSim
combustivelstringSim
precoFipestringSim
precoMediostringSim
vigenciastringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "registros": [
      {
        "status": "string",
        "chassi": "string",
        "codigoFipe": "string",
        "fabricante": "string",
        "modelo": "string",
        "anoModelo": "string",
        "combustivel": "string",
        "precoFipe": "string",
        "precoMedio": "string",
        "vigencia": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/fipe?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/historicoprop

Consulta o histórico de proprietários do veículo, por ano de exercício.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "03534225-b62c-4f44-953e-1f7b62533211",
    "dataConsulta": "25/06/2026 16:45:02",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "historicoprop",
    "tempoTotalMs": 0
  },
  "retorno": {
    "Placa": "ABC1D23",
    "Chassi": "XXXXXXXXXXXXXXXXX",
    "AnoFabricacao": "2023",
    "AnoModelo": "0",
    "DataPrimeiroEmplacamento": "ABC1D23",
    "UfDestinoFat": null,
    "QuantRegistros": 1,
    "Proprietarios": [
      {
        "AnoExercicio": "2023",
        "CpfCnpj": "00000000000000",
        "Nome": "NOME PROTEGIDO",
        "Uf": "PR"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/historicoprop?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/frotas

Consulta a frota de um CPF ou CNPJ — retorna todos os veículos encontrados para o documento pesquisado.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoCPF (11 dígitos) ou CNPJ (14 dígitos), somente números. 11 (CPF) ou 14 (CNPJ) dígitos, somente números.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/frotas?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/codsegcrv

Consulta o código de segurança do CRV — retorna o documento em base64.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCRV

Campos da resposta 11 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
crvBase64stringSim
mensagemErrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "705164a4-0bf1-405b-a2b0-868502936c76",
    "dataConsulta": "25/06/2026 15:01:58",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "codsegcrv",
    "tempoTotalMs": 9254
  },
  "retorno": {
    "placa": "ABC1D23",
    "crvBase64": "JVBERi0xLjUKJfbk/N8KMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1Byb2R1Y2VyIChSZW5h… [conteúdo truncado na documentação]",
    "mensagemErro": ""
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/codsegcrv?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/detalhescomunicado

Detalha o comunicado de venda registrado para o veículo — existência, ocorrências e dados do veículo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDetalhesComunicado

Campos da resposta 30 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
mensagemstringSim
existeComunicadoVendastringSim
quantidadeOcorrenciasstringSim
placastringSim
chassistringSim
renavamstringSim
marcaModelostringSim
corVeiculostringSim
anoModelostringSim
anoFabricacaostringSim
ufstringSim
municipiostringSim
proprietarioDocumentostringSim
proprietarioNomestringSim
ocorrenciasarray<OcorrenciaComunicadoView>Sim
placastringSim
renavamstringSim
documentoProprietariostringSim
dataVendastringSim
dataRegistroVendastringSim
documentoCompradorstringSim
nomeCompradorstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "mensagem": "string",
    "existeComunicadoVenda": "string",
    "quantidadeOcorrencias": "string",
    "placa": "string",
    "chassi": "string",
    "renavam": "string",
    "marcaModelo": "string",
    "corVeiculo": "string",
    "anoModelo": "string",
    "anoFabricacao": "string",
    "uf": "string",
    "municipio": "string",
    "proprietarioDocumento": "string",
    "proprietarioNome": "string",
    "ocorrencias": [
      {
        "placa": "string",
        "renavam": "string",
        "documentoProprietario": "string",
        "dataVenda": "string",
        "dataRegistroVenda": "string",
        "documentoComprador": "string",
        "nomeComprador": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/detalhescomunicado?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/recall

Consulta recall do veículo — histórico, observação e situação.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "f4b0e47c-ba5e-4099-aea3-22221a287643",
    "dataConsulta": "25/06/2026 15:00:25",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "recall",
    "tempoTotalMs": 30291
  },
  "retorno": {
    "Historico": null,
    "Observacao": null,
    "SituacaoRecall": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/recall?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Roubo, sinistro e leilão

Ocorrências de roubo/furto, indícios de sinistro, passagens por leilão e aceitação por seguradoras.

POST/api/Consultas/roubofurto

Consulta ocorrências de roubo/furto registradas para o veículo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewRouboFurto

Campos da resposta 34 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
mensagemstringSim
existeOcorrenciastringSim
chassistringSim
placastringSim
marcaModelostringSim
anoModelostringSim
anoFabricacaostringSim
corstringSim
municipioEmplacamentostringSim
ocorrenciasarray<Ocorrencia>Sim
declaracaostringSim
boletimstringSim
codigoOrgaoSegurancastringSim
ocorrenciastringSim
municipiostringSim
uFstringSim
dataOcorrenciastringSim
placastringSim
chassistringSim
marcaModelostringSim
corstringSim
informantestringSim
documentostringSim
numeroDocumentostringSim
ramalstringSim
telefonestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "6e1bc4a1-12da-4ce5-bf45-be47e895db3d",
    "dataConsulta": "25/06/2026 15:01:04",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "roubofurto",
    "tempoTotalMs": 63
  },
  "retorno": {
    "mensagem": "Não foi encontrado registro de roubo e furto",
    "existeOcorrencia": "NAO",
    "chassi": null,
    "placa": null,
    "marcaModelo": null,
    "anoModelo": null,
    "anoFabricacao": null,
    "cor": null,
    "municipioEmplacamento": null,
    "ocorrencias": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/roubofurto?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/roubofurto2

Consulta ocorrências de roubo/furto (base alternativa).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewRouboFurto2

Campos da resposta 34 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
mensagemstringSim
existeOcorrenciastringSim
chassistringSim
placastringSim
marcaModelostringSim
anoModelostringSim
anoFabricacaostringSim
corstringSim
municipioEmplacamentostringSim
ocorrenciasarray<Ocorrencia>Sim
declaracaostringSim
boletimstringSim
codigoOrgaoSegurancastringSim
ocorrenciastringSim
municipiostringSim
uFstringSim
dataOcorrenciastringSim
placastringSim
chassistringSim
marcaModelostringSim
corstringSim
informantestringSim
documentostringSim
numeroDocumentostringSim
ramalstringSim
telefonestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "8aaaf93d-cc93-449e-96eb-e118830d6c12",
    "dataConsulta": "25/06/2026 15:01:04",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "roubofurto2",
    "tempoTotalMs": 17410
  },
  "retorno": {
    "mensagem": "Não foi encontrado registro de roubo e furto",
    "existeOcorrencia": "NAO",
    "chassi": null,
    "placa": null,
    "marcaModelo": null,
    "anoModelo": null,
    "anoFabricacao": null,
    "cor": null,
    "municipioEmplacamento": null,
    "ocorrencias": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/roubofurto2?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/IndicioSinistro

Verifica se existe indício de sinistro registrado para o veículo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewIndicioSinistro

Campos da resposta 10 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
indicadorIndiciobooleanSim
mensagemSinistrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "6eaafadc-02e4-49f2-a067-cc491e46c122",
    "dataConsulta": "25/06/2026 14:59:33",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "IndicioSinistro",
    "tempoTotalMs": 3523
  },
  "retorno": {
    "indicadorIndicio": false,
    "mensagemSinistro": "NÃO EXISTE REGISTRO DE INDICIO DE SINISTRO"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/IndicioSinistro?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/IndicioSinistro1

Verifica indício de sinistro registrado para o veículo (variante 1).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewSinistro

Campos da resposta 10 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
indicioDeSinistrointeger (int32)Não
mensagemSinistrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "267f4eec-2e4b-425b-af18-2c3f52fb045b",
    "dataConsulta": "25/06/2026 14:59:00",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "IndicioSinistro1",
    "tempoTotalMs": 338
  },
  "retorno": {
    "indicioDeSinistro": 0,
    "mensagemSinistro": "NÃO EXISTE REGISTRO DE INDICIO DE SINISTRO"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/IndicioSinistro1?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/Leilao1

Consulta registros de leilão do veículo (base 1).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewLeilao

Campos da resposta 56 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
existeRegistrobooleanNão
placastringSim
chassistringSim
descricaostringSim
modelostringSim
situacaoChassistringSim
anoFabricacaostringSim
anoModelostringSim
combustivelstringSim
corstringSim
renavamstringSim
segmentostringSim
subSegmentostringSim
scorestringSim
aceitaVeiculostringSim
percentualSobreRefstringSim
exigenciaVistoriaEspecialstringSim
scorePontuacaostringSim
motorstringSim
numeroCaixaCambiostringSim
numeroCarroceriastringSim
numeroEixoTraseiroDiferencialstringSim
quantidadeDeEixosstringSim
registrosLeilaoarray<RegistroLeilaoView>Sim
leiloeirostringSim
comitentestringSim
lotestringSim
dataLeilaostringSim
condicoesVeiculostringSim
situacaoChassistringSim
condicoesMotorstringSim
condicoesCambiostringSim
condicoesMecanicastringSim
observacaostringSim
checkListobjectNão
frentestringSim
traseirastringSim
tetostringSim
interiorstringSim
lateralEsquerdastringSim
lateralDireitastringSim
rodasstringSim
queimadostringSim
airBagstringSim
obsstringSim
quantidadePesquisasUltimosMesesstringSim
historicoPesquisastringSim
controleHistoricostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "37455073-7786-4d2f-bc5e-4a9f40070f65",
    "dataConsulta": "25/06/2026 14:59:34",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Leilao1",
    "tempoTotalMs": 91
  },
  "retorno": {
    "existeRegistro": false,
    "placa": "ABC1D23",
    "chassi": "XXXXXXXXXXXXXXXXX",
    "descricao": "Nenhuma informação foi localizada com o dado informado",
    "modelo": "NAO INFORMADO",
    "situacaoChassi": "XXXXXXXXXXXXXXXXX",
    "anoFabricacao": "NAO INFORMADO",
    "anoModelo": "NAO INFORMADO",
    "combustivel": "NAO INFORMADO",
    "cor": "NAO INFORMADO",
    "renavam": "00000000000",
    "segmento": "NAO INFORMADO",
    "subSegmento": "NAO INFORMADO",
    "score": "NAO INFORMADO",
    "aceitaVeiculo": "NAO INFORMADO",
    "percentualSobreRef": "NAO INFORMADO",
    "exigenciaVistoriaEspecial": "NAO INFORMADO",
    "scorePontuacao": "NAO INFORMADO",
    "motor": "NAO INFORMADO",
    "numeroCaixaCambio": "NAO INFORMADO",
    "numeroCarroceria": "NAO INFORMADO",
    "numeroEixoTraseiroDiferencial": "NAO INFORMADO",
    "quantidadeDeEixos": "NAO INFORMADO",
    "registrosLeilao": [],
    "checkList": {
      "frente": "NAO INFORMADO",
      "traseira": "NAO INFORMADO",
      "teto": "NAO INFORMADO",
      "interior": "NAO INFORMADO",
      "lateralEsquerda": "NAO INFORMADO",
      "lateralDireita": "NAO INFORMADO",
      "rodas": "NAO INFORMADO",
      "queimado": "NAO INFORMADO",
      "airBag": "NAO INFORMADO",
      "obs": "NAO INFORMADO"
    },
    "quantidadePesquisasUltimosMeses": "7",
    "historicoPesquisa": "18/06/2026;16/06/2026;07/06/2026;26/05/2026;16/04/2026;13/04/2026;26/03/2026",
    "controleHistorico": "1"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/Leilao1?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/Leilao2

Consulta registros de leilão do veículo (base 2).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewLeilao2

Campos da resposta 30 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
temRegistrobooleanNão
leiloesarray<LeilaoItemView>Sim
lotestringSim
marcastringSim
modelostringSim
anoModelostringSim
anoFabricacaostringSim
chassistringSim
renavamstringSim
corstringSim
combustivelstringSim
dataLeilaostringSim
leiloeirostringSim
comitentestringSim
patiostringSim
categoriaVeiculostringSim
condicaoVeiculostringSim
nrMotorstringSim
nrCambiostringSim
quantidadeDeEixosstringSim
segmentoComitentestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "da0cd9e6-61d2-43a2-bc0b-f1fa4fea62ef",
    "dataConsulta": "25/06/2026 14:59:26",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Leilao2",
    "tempoTotalMs": 610
  },
  "retorno": {
    "placa": "ABC1D23",
    "temRegistro": false,
    "leiloes": []
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/Leilao2?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/Leilao3

Consulta registros de leilão do veículo (base 3 — detalhada).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewLeilao3

Campos da resposta 34 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
temRegistrobooleanNão
leiloesarray<Leilao3ItemView>Sim
nsuVeiculostringSim
idLeilaostringSim
lotestringSim
marcastringSim
modelostringSim
anoModelostringSim
anoFabricacaostringSim
chassistringSim
renavamstringSim
corstringSim
combustivelstringSim
categoriaVeiculostringSim
condicaoVeiculostringSim
situacaoChassistringSim
nrMotorstringSim
nrCambiostringSim
nrCarroceriastringSim
nrEixoTraseirostringSim
quantidadeEixosstringSim
patiostringSim
leiloeirostringSim
dataLeilaostringSim
comitentestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "9f40016f-8e8f-406c-85ec-9121dca5c3ed",
    "dataConsulta": "25/06/2026 14:59:27",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Leilao3",
    "tempoTotalMs": 457
  },
  "retorno": {
    "placa": "ABC1D23",
    "temRegistro": false,
    "leiloes": []
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/Leilao3?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/LeilaoRemarketing

Consulta de leilão e remarketing — retorna os blocos leilao e remarketing em uma resposta.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success
Exemplo de resposta
{
  "consulta": {
    "idConsulta": "3c5df064-4b3d-48a4-b99d-770663e0f83c",
    "dataConsulta": "25/06/2026 15:01:05",
    "parametro": "ABC1D23",
    "tipoConsulta": "LeilaoRem",
    "usuario": "AvaliService"
  },
  "resultados": {
    "leilao": {
      "existeRegistro": false,
      "placa": "ABC1D23",
      "chassi": "XXXXXXXXXXXXXXXXX",
      "descricao": "Nenhuma informação foi localizada com o dado informado",
      "modelo": "NAO INFORMADO",
      "situacaoChassi": "XXXXXXXXXXXXXXXXX",
      "anoFabricacao": "NAO INFORMADO",
      "anoModelo": "NAO INFORMADO",
      "combustivel": "NAO INFORMADO",
      "cor": "NAO INFORMADO",
      "renavam": "00000000000",
      "segmento": "NAO INFORMADO",
      "subSegmento": "NAO INFORMADO",
      "score": "NAO INFORMADO",
      "aceitaVeiculo": "NAO INFORMADO",
      "percentualSobreRef": "NAO INFORMADO",
      "exigenciaVistoriaEspecial": "NAO INFORMADO",
      "scorePontuacao": "NAO INFORMADO",
      "motor": "NAO INFORMADO",
      "numeroCaixaCambio": "NAO INFORMADO",
      "numeroCarroceria": "NAO INFORMADO",
      "numeroEixoTraseiroDiferencial": "NAO INFORMADO",
      "quantidadeDeEixos": "NAO INFORMADO",
      "registrosLeilao": [],
      "checkList": {
        "frente": "NAO INFORMADO",
        "traseira": "NAO INFORMADO",
        "teto": "NAO INFORMADO",
        "interior": "NAO INFORMADO",
        "lateralEsquerda": "NAO INFORMADO",
        "lateralDireita": "NAO INFORMADO",
        "rodas": "NAO INFORMADO",
        "queimado": "NAO INFORMADO",
        "airBag": "NAO INFORMADO",
        "obs": "NAO INFORMADO"
      },
      "quantidadePesquisasUltimosMeses": "7",
      "historicoPesquisa": "18/06/2026;16/06/2026;07/06/2026;26/05/2026;16/04/2026;13/04/2026;26/03/2026",
      "controleHistorico": "1"
    },
    "remarketing": {
      "existeRegistro": false,
      "placa": "ABC1D23",
      "chassi": "XXXXXXXXXXXXXXXXX",
      "descricao": "Nenhuma informação foi localizada com o dado informado",
      "resultadoPesquisa": "Sem registros",
      "modelo": "NAO INFORMADO",
      "situacaoChassi": "XXXXXXXXXXXXXXXXX",
      "anoFabricacao": "NAO INFORMADO",
      "anoModelo": "NAO INFORMADO",
      "combustivel": "NAO INFORMADO",
      "cor": "NAO INFORMADO",
      "renavam": "00000000000",
      "segmento": "NAO INFORMADO",
      "subSegmento": "NAO INFORMADO",
      "registrosRemarketing": [],
      "checkList": {
        "dataInspecao": "NAO INFORMADO",
        "motor": "NAO INFORMADO",
        "portaMalas": "NAO INFORMADO",
        "frente": "NAO INFORMADO",
        "frenteDireita": "NAO INFORMADO",
        "frenteEsquerda": "NAO INFORMADO",
        "portaFrenteDireita": "NAO INFORMADO",
        "portaFrenteEsquerda": "NAO INFORMADO",
        "portaTraseiraDireita": "NAO INFORMADO",
        "portaTraseiraEsquerda": "NAO INFORMADO",
        "traseiraDireita": "NAO INFORMADO",
        "traseiraEsquerda": "NAO INFORMADO",
        "ladoDireito": "NAO INFORMADO",
        "ladoEsquerdo": "NAO INFORMADO",
        "traseira": "NAO INFORMADO",
        "cacamba": "NAO INFORMADO",
        "bancosDianteiros": "NAO INFORMADO",
        "bancosTraseiros": "NAO INFORMADO",
        "forroTeto": "NAO INFORMADO",
        "teto": "NAO INFORMADO",
        "observacao": "NAO INFORMADO",
        "link1": "NAO INFORMADO",
        "link2": "NAO INFORMADO",
        "garantia": "NAO INFORMADO"
      },
      "fotos": []
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/LeilaoRemarketing?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/Remarketing

Consulta registro de remarketing do veículo — passagem, segmento e situação do chassi.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewRemarketing

Campos da resposta 59 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
existeRegistrobooleanNão
placastringSim
chassistringSim
descricaostringSim
resultadoPesquisastringSim
modelostringSim
situacaoChassistringSim
anoFabricacaostringSim
anoModelostringSim
combustivelstringSim
corstringSim
renavamstringSim
segmentostringSim
subSegmentostringSim
registrosRemarketingarray<RegistroRemarketingView>Sim
organizadorstringSim
vendedorstringSim
itemstringSim
dataEventostringSim
condicoesVeiculostringSim
situacaoChassistringSim
condicoesMotorstringSim
condicoesCambiostringSim
condicoesMecanicastringSim
observacaostringSim
checkListobjectNão
dataInspecaostringSim
motorstringSim
portaMalasstringSim
frentestringSim
frenteDireitastringSim
frenteEsquerdastringSim
portaFrenteDireitastringSim
portaFrenteEsquerdastringSim
portaTraseiraDireitastringSim
portaTraseiraEsquerdastringSim
traseiraDireitastringSim
traseiraEsquerdastringSim
ladoDireitostringSim
ladoEsquerdostringSim
traseirastringSim
cacambastringSim
bancosDianteirosstringSim
bancosTraseirosstringSim
forroTetostringSim
tetostringSim
observacaostringSim
link1stringSim
link2stringSim
garantiastringSim
fotosarray<string>Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "2339e9d4-bb07-4746-9161-033969ddec9d",
    "dataConsulta": "25/06/2026 14:59:35",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "Remarketing",
    "tempoTotalMs": 103
  },
  "retorno": {
    "existeRegistro": false,
    "placa": "ABC1D23",
    "chassi": "XXXXXXXXXXXXXXXXX",
    "descricao": "Nenhuma informação foi localizada com o dado informado",
    "resultadoPesquisa": "Sem registros",
    "modelo": "NAO INFORMADO",
    "situacaoChassi": "XXXXXXXXXXXXXXXXX",
    "anoFabricacao": "NAO INFORMADO",
    "anoModelo": "NAO INFORMADO",
    "combustivel": "NAO INFORMADO",
    "cor": "NAO INFORMADO",
    "renavam": "00000000000",
    "segmento": "NAO INFORMADO",
    "subSegmento": "NAO INFORMADO",
    "registrosRemarketing": [],
    "checkList": {
      "dataInspecao": "NAO INFORMADO",
      "motor": "NAO INFORMADO",
      "portaMalas": "NAO INFORMADO",
      "frente": "NAO INFORMADO",
      "frenteDireita": "NAO INFORMADO",
      "frenteEsquerda": "NAO INFORMADO",
      "portaFrenteDireita": "NAO INFORMADO",
      "portaFrenteEsquerda": "NAO INFORMADO",
      "portaTraseiraDireita": "NAO INFORMADO",
      "portaTraseiraEsquerda": "NAO INFORMADO",
      "traseiraDireita": "NAO INFORMADO",
      "traseiraEsquerda": "NAO INFORMADO",
      "ladoDireito": "NAO INFORMADO",
      "ladoEsquerdo": "NAO INFORMADO",
      "traseira": "NAO INFORMADO",
      "cacamba": "NAO INFORMADO",
      "bancosDianteiros": "NAO INFORMADO",
      "bancosTraseiros": "NAO INFORMADO",
      "forroTeto": "NAO INFORMADO",
      "teto": "NAO INFORMADO",
      "observacao": "NAO INFORMADO",
      "link1": "NAO INFORMADO",
      "link2": "NAO INFORMADO",
      "garantia": "NAO INFORMADO"
    },
    "fotos": []
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/Remarketing?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/ParecerTecnico

Obtém o parecer técnico do veículo com semáforo de risco.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewParecerTecnico

Campos da resposta 14 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
descricaostringSim
resultadoPesquisastringSim
parecerTecnicostringSim
semaforostringSim
imagemstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "6d79ca1f-fa4c-4206-a77d-ff1aebfc9ab4",
    "dataConsulta": "25/06/2026 14:59:28",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "ParecerTecnico",
    "tempoTotalMs": 461
  },
  "retorno": {
    "placa": "ABC1D23",
    "descricao": "Sucesso",
    "resultadoPesquisa": "RegistroLocalizado",
    "parecerTecnico": "1",
    "semaforo": "verde",
    "imagem": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/ParecerTecnico?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/validacaoseguros

Consulta de aceitação do veículo junto a seguradoras — status, código de aceitação e franquia por seguradora.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewValidacaoSeguros

Campos da resposta 19 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
dataRespostastringSim
seguradorasarray<ValidacaoSeguroSeguradora>Sim
idSeguradorastringSim
seguradorastringSim
statusstringSim
codigoAceitacaostringSim
aceitacaostringSim
franquiastringSim
observacoesstringSim
informacoesImportantesarray<string>Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "placa": "string",
    "dataResposta": "string",
    "seguradoras": [
      {
        "idSeguradora": "string",
        "seguradora": "string",
        "status": "string",
        "codigoAceitacao": "string",
        "aceitacao": "string",
        "franquia": "string"
      }
    ],
    "observacoes": "string",
    "informacoesImportantes": [
      "string"
    ]
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/validacaoseguros?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Gravame e restrições

Gravames, restrições judiciais RENAJUD e infrações RENAINF.

POST/api/Consultas/detalhesgravame

Consulta detalhada do gravame ativo do veículo — financeira, contrato e datas.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewGravame

Campos da resposta 51 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
temGravamebooleanNão
mensagemStatusstringSim
chassiSngstringSim
chaveRetornostringSim
placastringSim
ufPlacastringSim
anoFabricacaostringSim
anoModelostringSim
renavamstringSim
documentoProprietariostringSim
nomeFinanciadostringSim
numeroContratostringSim
documentoFinanceirastringSim
financeiraNomestringSim
codigoFinanceirastringSim
dataGravamestringSim
dataGravameVigenciastringSim
ufGravamestringSim
statusDoVeiculostringSim
descricaoStatusstringSim
marcaModelostringSim
tipostringSim
cambiostringSim
combustivelstringSim
corstringSim
especiestringSim
motorstringSim
potenciastringSim
situacaoChassistringSim
capacidadeCilindradastringSim
quantidadePassageirosstringSim
procedenciastringSim
tipoCarroceriastringSim
tipoMontagemstringSim
capacidadeCargastringSim
cmtstringSim
pbtstringSim
eixoQuantidadestringSim
eixoAuxiliarstringSim
eixoTraseirostringSim
docImportadorstringSim
dataAtualizacaostringSim
dataLimiteRestricaoTributariastringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "4958a04a-2b73-4466-9ed8-eb1d4f6d30c8",
    "dataConsulta": "25/06/2026 14:59:29",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "detalhesgravame",
    "tempoTotalMs": 1019
  },
  "retorno": {
    "temGravame": false,
    "mensagemStatus": "Veículo não possui gravame ativo",
    "chassiSng": "XXXXXXXXXXXXXXXXX",
    "chaveRetorno": "260625145929992",
    "placa": "ABC1D23",
    "ufPlaca": "ABC1D23",
    "anoFabricacao": "1979",
    "anoModelo": "0",
    "renavam": "00000000000",
    "documentoProprietario": "00000000000",
    "nomeFinanciado": "",
    "numeroContrato": "",
    "documentoFinanceira": "",
    "financeiraNome": "",
    "codigoFinanceira": "",
    "dataGravame": "",
    "dataGravameVigencia": "",
    "ufGravame": "",
    "statusDoVeiculo": "",
    "descricaoStatus": "VEICULO SEM RESTRICOES ATIVAS NA BASE SNG",
    "marcaModelo": null,
    "tipo": null,
    "cambio": null,
    "combustivel": null,
    "cor": null,
    "especie": null,
    "motor": null,
    "potencia": null,
    "situacaoChassi": null,
    "capacidadeCilindrada": null,
    "quantidadePassageiros": null,
    "procedencia": null,
    "tipoCarroceria": null,
    "tipoMontagem": null,
    "capacidadeCarga": null,
    "cmt": null,
    "pbt": null,
    "eixoQuantidade": null,
    "eixoAuxiliar": null,
    "eixoTraseiro": null,
    "docImportador": null,
    "dataAtualizacao": null,
    "dataLimiteRestricaoTributaria": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/detalhesgravame?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/detalhesGravameHist

Histórico completo de gravames do veículo — todos os registros, com agente financeiro e datas.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewGravameHist

Campos da resposta 38 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
chassistringSim
placastringSim
ufPlacastringSim
renavamstringSim
marcaModelostringSim
corstringSim
anoModelostringSim
anoFabricacaostringSim
tipoVeiculostringSim
combustivelstringSim
procedenciastringSim
quantidadeGravamesstringSim
gravamesarray<OcorrenciaGravameView>Sim
codigoStatusstringSim
statusGravamestringSim
statusVeiculostringSim
dataAtualizacaoStatusstringSim
renavamstringSim
ufPlacastringSim
placastringSim
ufLicenciamentostringSim
chassistringSim
docFinanciadostringSim
nomeFinanciadostringSim
docAgentestringSim
nomeAgentestringSim
numeroGravamestringSim
numeroContratostringSim
dataInclusaoGravamestringSim
dataContratostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "51c1be72-98b5-4f86-8ec4-eceabca41e9b",
    "dataConsulta": "25/06/2026 14:59:44",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "detalhesGravameHist",
    "tempoTotalMs": 8258
  },
  "retorno": {
    "chassi": "XXXXXXXXXXXXXXXXX",
    "placa": "ABC1D23",
    "ufPlaca": "ABC1D23",
    "renavam": "00000000000",
    "marcaModelo": "PASSAT TS",
    "cor": "0",
    "anoModelo": "0",
    "anoFabricacao": "1979",
    "tipoVeiculo": "AUTOMOVEL",
    "combustivel": "0",
    "procedencia": "NACIONAL",
    "quantidadeGravames": "1",
    "gravames": [
      {
        "codigoStatus": "1",
        "statusGravame": "VEICULO SEM RESTRICOES ATIVAS NA BASE SNG",
        "statusVeiculo": "VEICULO SEM RESTRICOES ATIVAS NA BASE SNG",
        "dataAtualizacaoStatus": "",
        "renavam": "00000000000",
        "ufPlaca": "ABC1D23",
        "placa": "ABC1D23",
        "ufLicenciamento": "NADA CONSTA",
        "chassi": "",
        "docFinanciado": "0",
        "nomeFinanciado": "",
        "docAgente": "NADA CONSTA",
        "nomeAgente": "NOME PROTEGIDO",
        "numeroGravame": "",
        "numeroContrato": "",
        "dataInclusaoGravame": "NADA CONSTA",
        "dataContrato": ""
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/detalhesGravameHist?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/renajud

Consulta restrições judiciais (RENAJUD) do veículo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewRenajud

Campos da resposta 38 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
marcaModelostringSim
municipiostringSim
renavamstringSim
corstringSim
anoFabricacaostringSim
anoModelostringSim
chassistringSim
placastringSim
combustivelstringSim
especiestringSim
motorstringSim
procedenciastringSim
tipostringSim
mensagemstringSim
quantidadeOcorrenciasTotalstringSim
quantidadeBloqueioAtivostringSim
ocorrenciasarray<OcorrenciaRenajud>Sim
constaRestricaostringSim
chassistringSim
placastringSim
municipioOrgaostringSim
tipoRestricaostringSim
nomeTribunalstringSim
nomeOrgaoJudicialstringSim
numeroProcessostringSim
dataInclusaostringSim
exclusaoobjectNão
datastringSim
magistradostringSim
orgaostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "222f00a6-efde-47c0-9104-49f43f1d2828",
    "dataConsulta": "25/06/2026 15:01:41",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "renajud",
    "tempoTotalMs": 3756
  },
  "retorno": {
    "marcaModelo": "VW/PASSAT TS",
    "municipio": "CURITIBA/PR",
    "renavam": "00000000000",
    "cor": "AZUL",
    "anoFabricacao": "1979",
    "anoModelo": "1979",
    "chassi": "XXXXXXXXXXXXXXXXX",
    "placa": "ABC1D23",
    "combustivel": "GASOLINA",
    "especie": null,
    "motor": "*",
    "procedencia": null,
    "tipo": null,
    "mensagem": null,
    "quantidadeOcorrenciasTotal": "0",
    "quantidadeBloqueioAtivo": "0",
    "ocorrencias": null
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/renajud?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/renajud2

Consulta restrições judiciais (RENAJUD, base alternativa) com detalhamento de bloqueios ativos.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewRenajud2

Campos da resposta 44 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
placaAnteriorstringSim
chassistringSim
renavamstringSim
marcaModelostringSim
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
ufstringSim
proprietarioobjectNão
nomestringSim
documentostringSim
enderecostringSim
mensagemstringSim
quantidadeOcorrenciasTotalinteger (int32)Não
quantidadeBloqueioAtivointeger (int32)Não
quantidadeBaixadasinteger (int32)Não
ocorrenciasarray<OcorrenciaRenajud2>Sim
idstringSim
statusstringSim
tipoRestricaostringSim
numeroProcessostringSim
tribunalobjectNão
idstringSim
nomestringSim
orgaoJulgadorobjectNão
idinteger (int64)Sim
nomestringSim
municipiostringSim
ufstringSim
inclusaoobjectNão
datastringSim
magistradostringSim
exclusaoobjectNão
datastringSim
magistradostringSim
orgaostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "56a9b726-4559-48d2-9f73-32f82ae289cb",
    "dataConsulta": "25/06/2026 15:01:42",
    "parametro": "ABC1D23",
    "usuario": "AvaliService",
    "tipoConsulta": "renajud2",
    "tempoTotalMs": 94
  },
  "retorno": {
    "placa": "ABC1D23",
    "placaAnterior": null,
    "chassi": "XXXXXXXXXXXXXXXXX",
    "renavam": "00000000000",
    "marcaModelo": "VW/PASSAT TS",
    "anoFabricacao": 1979,
    "anoModelo": 1979,
    "uf": "PR",
    "proprietario": {
      "nome": "NOME PROTEGIDO",
      "documento": "00000000000",
      "endereco": null
    },
    "mensagem": "CONSTA BLOQUEIO RENAJUD / BLOQUEIO-ATIVO NADA CONSTA",
    "quantidadeOcorrenciasTotal": 0,
    "quantidadeBloqueioAtivo": 0,
    "quantidadeBaixadas": 0,
    "ocorrencias": []
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/renajud2?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/renainf

Consulta ocorrências no RENAINF (Registro Nacional de Infrações de Trânsito).

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewRenainf

Campos da resposta 54 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
mensagemstringSim
quantidadeOcorrenciasstringSim
ocorrenciasarray<OcorrenciaRenainfView>Sim
descricaostringSim
autoInfracaostringSim
dataInfracaostringSim
exigibilidadestringSim
infracaostringSim
orgaoAtuadorstringSim
detalhesobjectNão
dadosNotificacaoobjectNão
cadastroInfracaostringSim
codigoInfracaostringSim
codigoMunicipalEmplacamentostringSim
codigoMunicipalInfracaostringSim
dataEmissaoPenalidadestringSim
dataInfracaostringSim
dataNotificacaoInfracaostringSim
horaInfracaostringSim
limitePermitidostringSim
localInfracaostringSim
marcaModelostringSim
medicaoConsideradastringSim
medicaoRealstringSim
numeroAutoInfracaostringSim
orgaoAutuadorstringSim
ufOrgaoAutuadorstringSim
placastringSim
ufPlacastringSim
ufJurisdicaoVeiculostringSim
tipoAutoInfracaostringSim
valorInfracaostringSim
unidadeMedidastringSim
dadosSuspensaoobjectNão
aceiteUfJurisdicaostringSim
dataRegistrostringSim
origemstringSim
tipostringSim
dadosInfratorobjectNão
cnhCondutorstringSim
cnhInfratorstringSim
dadosPagamentoobjectNão
dtPagamentostringSim
dtRegistroPgtostringSim
ufPagamentostringSim
valorPagostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "mensagem": "string",
    "quantidadeOcorrencias": "string",
    "ocorrencias": [
      {
        "descricao": "string",
        "autoInfracao": "string",
        "dataInfracao": "string",
        "exigibilidade": "string",
        "infracao": "string",
        "orgaoAtuador": "string",
        "detalhes": {
          "dadosNotificacao": {
            "cadastroInfracao": "string",
            "codigoInfracao": "string",
            "codigoMunicipalEmplacamento": "string",
            "codigoMunicipalInfracao": "string",
            "dataEmissaoPenalidade": "string",
            "dataInfracao": "string",
            "dataNotificacaoInfracao": "string",
            "horaInfracao": "string",
            "limitePermitido": "string",
            "localInfracao": "string",
            "marcaModelo": "string",
            "medicaoConsiderada": "string",
            "medicaoReal": "string",
            "numeroAutoInfracao": "string",
            "orgaoAutuador": "string",
            "ufOrgaoAutuador": "string",
            "placa": "string",
            "ufPlaca": "string",
            "ufJurisdicaoVeiculo": "string",
            "tipoAutoInfracao": "string",
            "valorInfracao": "string",
            "unidadeMedida": "string"
          },
          "dadosSuspensao": {
            "aceiteUfJurisdicao": "string",
            "dataRegistro": "string",
            "origem": "string",
            "tipo": "string"
          },
          "dadosInfrator": {
            "cnhCondutor": "string",
            "cnhInfrator": "string"
          },
          "dadosPagamento": {
            "dtPagamento": "string",
            "dtRegistroPgto": "string",
            "ufPagamento": "string",
            "valorPago": "string"
          }
        }
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/renainf?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Débitos veiculares

IPVA, licenciamento e multas.

POST/api/Consultas/debitosveiculares

Consulta débitos veiculares (IPVA, licenciamento, multas) com boletos.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDebitosVeiculares

Campos da resposta 41 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
debitosarray<DebitoDetalhe>Sim
codigoBarrasstringSim
linhaDigitavelstringSim
valorTotalstringSim
valorSubtotalstringSim
valorTaxasstringSim
valorMultastringSim
valorParcelastringSim
dataVencimentostringSim
dataVencimentoOriginalstringSim
dataReferenciastringSim
identificadorstringSim
descricaostringSim
motivoIndisponibilidadestringSim
guidPagamentostringSim
statusPagamentostringSim
tipointeger (int32)Não
infracaoTransitoobjectNão
codigostringSim
artigostringSim
descricaostringSim
pontosinteger (int32)Não
gravidadestringSim
responsavelstringSim
valorBasestringSim
dadosExtrasarray<DadoExtra>Sim
grupostringSim
chavestringSim
valor1stringSim
valor2stringSim
valor3stringSim
valorTotalDebitosstringSim
quantidadeDebitosinteger (int32)Não
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "debitos": [
      {
        "codigoBarras": "string",
        "linhaDigitavel": "string",
        "valorTotal": "string",
        "valorSubtotal": "string",
        "valorTaxas": "string",
        "valorMulta": "string",
        "valorParcela": "string",
        "dataVencimento": "string",
        "dataVencimentoOriginal": "string",
        "dataReferencia": "string",
        "identificador": "string",
        "descricao": "string",
        "motivoIndisponibilidade": "string",
        "guidPagamento": "string",
        "statusPagamento": "string",
        "tipo": 0,
        "infracaoTransito": {
          "codigo": "string",
          "artigo": "string",
          "descricao": "string",
          "pontos": 0,
          "gravidade": "string",
          "responsavel": "string",
          "valorBase": "string"
        },
        "dadosExtras": [
          {
            "grupo": "string",
            "chave": "string",
            "valor1": "string",
            "valor2": "string",
            "valor3": "string"
          }
        ]
      }
    ],
    "valorTotalDebitos": "string",
    "quantidadeDebitos": 0
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/debitosveiculares?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/debitos2

Consulta débitos veiculares (base alternativa) — dados do veículo e débitos.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDebitos2

Campos da resposta 82 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
veiculoobjectNão
placastringSim
chassistringSim
renavamstringSim
numeroMotorstringSim
numeroCambiostringSim
situacaostringSim
municipioEmplacamentostringSim
ufstringSim
procedenciastringSim
marcaModelostringSim
corstringSim
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
anoLicenciamentoPagostringSim
tipostringSim
especiestringSim
tipoCarroceriastringSim
numeroCarroceriastringSim
categoriastringSim
cilindradasinteger (int32)Sim
potenciainteger (int32)Sim
combustivelstringSim
pbtstringSim
cmtstringSim
cmcstringSim
capacidadePassageirosinteger (int32)Sim
quantidadeEixosinteger (int32)Sim
dataEmissaoCrvstringSim
dataEmissaoCrlvstringSim
remarcacaoChassistringSim
proprietarioobjectNão
nomestringSim
documentostringSim
tipostringSim
faturadoobjectNão
nomestringSim
documentostringSim
tipostringSim
restricoesarray<string>Sim
indicadoresobjectNão
renajudbooleanSim
rouboFurtobooleanSim
leilaobooleanSim
comunicadoVendabooleanSim
rfbbooleanSim
alarmebooleanSim
siniavbooleanSim
recallbooleanSim
pendenciaEmissaobooleanSim
importacaoobjectNão
numeroDeclaracaostringSim
datastringSim
faturamentoobjectNão
ufstringSim
documentostringSim
debitosarray<Debitos2Detalhe>Sim
descricaostringSim
identificadorstringSim
situacaostringSim
valorstringSim
dataVencimentostringSim
codigoFaturastringSim
codigoDebitostringSim
codigoNsustringSim
codigoBarrasstringSim
exigivelinteger (int32)Sim
codigoAutoInfracaostringSim
autoInfracaostringSim
darConcessaobooleanSim
mensagemCdabooleanSim
remetidaProtestobooleanSim
valorTotalDebitosstringSim
quantidadeDebitosinteger (int32)Não
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "veiculo": {
      "placa": "string",
      "chassi": "string",
      "renavam": "string",
      "numeroMotor": "string",
      "numeroCambio": "string",
      "situacao": "string",
      "municipioEmplacamento": "string",
      "uf": "string",
      "procedencia": "string",
      "marcaModelo": "string",
      "cor": "string",
      "anoFabricacao": 0,
      "anoModelo": 0,
      "anoLicenciamentoPago": "string",
      "tipo": "string",
      "especie": "string",
      "tipoCarroceria": "string",
      "numeroCarroceria": "string",
      "categoria": "string",
      "cilindradas": 0,
      "potencia": 0,
      "combustivel": "string",
      "pbt": "string",
      "cmt": "string",
      "cmc": "string",
      "capacidadePassageiros": 0,
      "quantidadeEixos": 0,
      "dataEmissaoCrv": "string",
      "dataEmissaoCrlv": "string",
      "remarcacaoChassi": "string",
      "proprietario": {
        "nome": "string",
        "documento": "string",
        "tipo": "string"
      },
      "faturado": {
        "nome": "string",
        "documento": "string",
        "tipo": "string"
      },
      "restricoes": [
        "string"
      ],
      "indicadores": {
        "renajud": false,
        "rouboFurto": false,
        "leilao": false,
        "comunicadoVenda": false,
        "rfb": false,
        "alarme": false,
        "siniav": false,
        "recall": false,
        "pendenciaEmissao": false
      },
      "importacao": {
        "numeroDeclaracao": "string",
        "data": "string"
      },
      "faturamento": {
        "uf": "string",
        "documento": "string"
      }
    },
    "debitos": [
      {
        "descricao": "string",
        "identificador": "string",
        "situacao": "string",
        "valor": "string",
        "dataVencimento": "string",
        "codigoFatura": "string",
        "codigoDebito": "string",
        "codigoNsu": "string",
        "codigoBarras": "string",
        "exigivel": 0,
        "codigoAutoInfracao": "string",
        "autoInfracao": "string",
        "darConcessao": false,
        "mensagemCda": false,
        "remetidaProtesto": false
      }
    ],
    "valorTotalDebitos": "string",
    "quantidadeDebitos": 0
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/debitos2?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

CRLV digital

Emissão do CRLV-e por UF. O padrão de chamada é o mesmo: POST com a placa na query string.

POST/api/Consultas/crlv

Obtém o CRLV digital do veículo — documento retornado em base64.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.
ufquerystringNãoUF de registro do veículo (sigla do estado, ex.: SP).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCRLV

Campos da resposta 13 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
ufstringSim
placastringSim
statusstringSim
crlvBase64stringSim
mensagemErrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "uf": "string",
    "placa": "string",
    "status": "string",
    "crlvBase64": "string",
    "mensagemErro": "string"
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlv?placa=VALOR&uf=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvsp

Obtém o CRLV-e do veículo para placas de São Paulo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.
renavamquerystringNãoCódigo RENAVAM do veículo (11 dígitos). Até 11 dígitos.
documentoquerystringNãoCPF (11 dígitos) ou CNPJ (14 dígitos), somente números. 11 (CPF) ou 14 (CNPJ) dígitos, somente números.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCRLV

Campos da resposta 13 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
ufstringSim
placastringSim
statusstringSim
crlvBase64stringSim
mensagemErrostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "uf": "string",
    "placa": "string",
    "status": "string",
    "crlvBase64": "string",
    "mensagemErro": "string"
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvsp?placa=VALOR&renavam=VALOR&documento=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvsp3

Obtém o CRLV-e do veículo (São Paulo, base alternativa).

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewECRLV

Campos da resposta 14 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
bancostringSim
situacaostringSim
placastringSim
renavamstringSim
documentostringSim
ecrlvBase64stringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "banco": "string",
    "situacao": "string",
    "placa": "string",
    "renavam": "string",
    "documento": "string",
    "ecrlvBase64": "string"
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvsp3?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvsp4

Obtém o CRLV-e do veículo (São Paulo, base 4).

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvsp4?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvsp4get

Recupera o resultado da consulta crlvsp4.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvsp4get?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvrj

Obtém o CRLV-e do veículo para placas do Rio de Janeiro.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvrj?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvrj2

Obtém o CRLV-e do veículo para placas do Rio de Janeiro (base alternativa) — dados do veículo e documento em base64.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCRLVRJ2

Campos da resposta 18 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
placastringSim
ufstringSim
municipiostringSim
chassistringSim
renavamstringSim
documentostringSim
marcastringSim
anoFabricacaostringSim
anoModelostringSim
base64stringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "placa": "string",
    "uf": "string",
    "municipio": "string",
    "chassi": "string",
    "renavam": "string",
    "documento": "string",
    "marca": "string",
    "anoFabricacao": "string",
    "anoModelo": "string",
    "base64": "string"
  }
}
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvrj2?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvap

Obtém o CRLV-e do veículo para placas do Amapá.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvap?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvba

Obtém o CRLV-e do veículo para placas da Bahia.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvba?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvce

Obtém o CRLV-e do veículo para placas do Ceará.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvce?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvgo

Obtém o CRLV-e do veículo para placas de Goiás.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvgo?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvma

Obtém o CRLV-e do veículo para placas do Maranhão.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvma?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvmg

Obtém o CRLV-e do veículo para placas de Minas Gerais.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvmg?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvms

Obtém o CRLV-e do veículo para placas de Mato Grosso do Sul.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvms?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvmt

Obtém o CRLV-e do veículo para placas de Mato Grosso.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvmt?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvpa

Obtém o CRLV-e do veículo para placas do Pará.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvpa?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvpi

Obtém o CRLV-e do veículo para placas do Piauí.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvpi?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvpr

Obtém o CRLV-e do veículo para placas do Paraná.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvpr?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvro

Obtém o CRLV-e do veículo para placas de Rondônia.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvro?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvrr

Obtém o CRLV-e do veículo para placas de Roraima.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvrr?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvrn

Obtém o CRLV-e do veículo para placas do Rio Grande do Norte.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvrn?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvse

Obtém o CRLV-e do veículo para placas de Sergipe.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvse?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/crlvto

Obtém o CRLV-e do veículo para placas do Tocantins.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/crlvto?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

CRLV assíncrono (RJ)

Fluxo assíncrono: solicitação, acompanhamento por protocolo e webhook de retorno.

POST/api/CrlvAsync/crlvasyncrj

Solicita a emissão assíncrona do CRLV-e (RJ); o acompanhamento é feito pelo protocolo interno.

Parâmetros

NomeOndeTipoObrigatórioDescrição
placaquerystringNãoPlaca do veículo (formato Mercosul ABC1D23 ou antigo ABC1234). 7 caracteres, sem hífen.

Respostas

201 Created
400 Bad Request

Schema: ProblemDetails

403 Forbidden

Schema: ProblemDetails

502 Server Error
503 Server Error

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/CrlvAsync/crlvasyncrj?placa=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
GET/api/CrlvAsync/{protocoloInterno}

Consulta a situação da solicitação assíncrona pelo protocolo interno.

Parâmetros

NomeOndeTipoObrigatórioDescrição
protocoloInternopathstringSimProtocolo interno do comunicado de venda.
base64querybooleanNão—

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

404 Not Found

Schema: ProblemDetails

Exemplo cURL

curl -X GET "https://api.avaliservice.com.br/api/CrlvAsync/PROTOCOLO?base64=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
PUT/api/CrlvAsync/webhook-cliente

Cadastra ou atualiza a URL de webhook do cliente para receber o resultado das solicitações assíncronas.

Corpo da requisição

Schema: WebhookClienteRequest

Campos do corpo 2 campos
CampoTipoNullable
urlstringSim
secretstringSim
{
  "url": "string",
  "secret": "string"
}

Respostas

200 Success

Retorno não tipado no contrato OpenAPI — o Swagger não declara os campos desta resposta.

400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X PUT "https://api.avaliservice.com.br/api/CrlvAsync/webhook-cliente" \
  -H "Authorization: Bearer <SEU_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"url": "string", "secret": "string"}'

CNH

Consultas de habilitação por CPF.

POST/api/Consultas/cnh

Consulta dados da CNH (Carteira Nacional de Habilitação) por CPF.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoCPF (somente números, 11 dígitos). 11 dígitos, somente números.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCNH

Campos da resposta 66 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
numeroRegistrostringSim
numeroFormularioRenachstringSim
numeroFormularioCnhstringSim
categoriaAtualstringSim
categoriaAutorizadastringSim
dataValidadestringSim
dataPrimeiraHabilitacaostringSim
dataUltimaEmissaostringSim
dataCadastramentostringSim
ufDominiostringSim
observacaostringSim
permissionadostringSim
situacaostringSim
situacaoAnteriorstringSim
cpfstringSim
nomestringSim
emailstringSim
dataNascimentostringSim
tipoDocumentostringSim
documentostringSim
orgaoExpedidorstringSim
ufOrgaoExpedidorstringSim
nacionalidadestringSim
localNascimentostringSim
sexostringSim
nomeMaestringSim
nomePaistringSim
logradourostringSim
numerostringSim
bairrostringSim
municipiostringSim
ufstringSim
cepstringSim
complementostringSim
bloqueiosarray<Models_RetornoViews_RetornoViewCNH_BloqueioInfo>Sim
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
toxicologicoDataExamestringSim
toxicologicoDataValidadestringSim
cursosarray<CursoContainer>Sim
cursoobjectNão
tipostringSim
descricaoTipostringSim
classificacaostringSim
ufstringSim
datastringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "numeroRegistro": "string",
    "numeroFormularioRenach": "string",
    "numeroFormularioCnh": "string",
    "categoriaAtual": "string",
    "categoriaAutorizada": "string",
    "dataValidade": "string",
    "dataPrimeiraHabilitacao": "string",
    "dataUltimaEmissao": "string",
    "dataCadastramento": "string",
    "ufDominio": "string",
    "observacao": "string",
    "permissionado": "string",
    "situacao": "string",
    "situacaoAnterior": "string",
    "cpf": "string",
    "nome": "string",
    "email": "string",
    "dataNascimento": "string",
    "tipoDocumento": "string",
    "documento": "string",
    "orgaoExpedidor": "string",
    "ufOrgaoExpedidor": "string",
    "nacionalidade": "string",
    "localNascimento": "string",
    "sexo": "string",
    "nomeMae": "string",
    "nomePai": "string",
    "logradouro": "string",
    "numero": "string",
    "bairro": "string",
    "municipio": "string",
    "uf": "string",
    "cep": "string",
    "complemento": "string",
    "bloqueios": [
      {
        "mensagem": "string",
        "dataInicioPenalidade": "string",
        "dataTerminoPenalidade": "string",
        "descricao": "string",
        "descricaoMotivo": "string",
        "documentoGerador": "string",
        "decisao": "string",
        "prazo": "string",
        "descricaoPrazo": "string",
        "prazoTotal": "string",
        "descricaoPrazoTotal": "string",
        "recolhimentoCNH": "string",
        "ufDetran": "string",
        "orgaoResponsavel": "string"
      }
    ],
    "toxicologicoDataExame": "string",
    "toxicologicoDataValidade": "string",
    "cursos": [
      {
        "curso": {
          "tipo": "string",
          "descricaoTipo": "string",
          "classificacao": "string",
          "uf": "string",
          "data": "string"
        }
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/cnh?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/cnh2

Consulta dados da CNH por CPF (base alternativa).

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoCPF (somente números, 11 dígitos). 11 dígitos, somente números.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCNH

Campos da resposta 66 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
numeroRegistrostringSim
numeroFormularioRenachstringSim
numeroFormularioCnhstringSim
categoriaAtualstringSim
categoriaAutorizadastringSim
dataValidadestringSim
dataPrimeiraHabilitacaostringSim
dataUltimaEmissaostringSim
dataCadastramentostringSim
ufDominiostringSim
observacaostringSim
permissionadostringSim
situacaostringSim
situacaoAnteriorstringSim
cpfstringSim
nomestringSim
emailstringSim
dataNascimentostringSim
tipoDocumentostringSim
documentostringSim
orgaoExpedidorstringSim
ufOrgaoExpedidorstringSim
nacionalidadestringSim
localNascimentostringSim
sexostringSim
nomeMaestringSim
nomePaistringSim
logradourostringSim
numerostringSim
bairrostringSim
municipiostringSim
ufstringSim
cepstringSim
complementostringSim
bloqueiosarray<Models_RetornoViews_RetornoViewCNH_BloqueioInfo>Sim
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
toxicologicoDataExamestringSim
toxicologicoDataValidadestringSim
cursosarray<CursoContainer>Sim
cursoobjectNão
tipostringSim
descricaoTipostringSim
classificacaostringSim
ufstringSim
datastringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "numeroRegistro": "string",
    "numeroFormularioRenach": "string",
    "numeroFormularioCnh": "string",
    "categoriaAtual": "string",
    "categoriaAutorizada": "string",
    "dataValidade": "string",
    "dataPrimeiraHabilitacao": "string",
    "dataUltimaEmissao": "string",
    "dataCadastramento": "string",
    "ufDominio": "string",
    "observacao": "string",
    "permissionado": "string",
    "situacao": "string",
    "situacaoAnterior": "string",
    "cpf": "string",
    "nome": "string",
    "email": "string",
    "dataNascimento": "string",
    "tipoDocumento": "string",
    "documento": "string",
    "orgaoExpedidor": "string",
    "ufOrgaoExpedidor": "string",
    "nacionalidade": "string",
    "localNascimento": "string",
    "sexo": "string",
    "nomeMae": "string",
    "nomePai": "string",
    "logradouro": "string",
    "numero": "string",
    "bairro": "string",
    "municipio": "string",
    "uf": "string",
    "cep": "string",
    "complemento": "string",
    "bloqueios": [
      {
        "mensagem": "string",
        "dataInicioPenalidade": "string",
        "dataTerminoPenalidade": "string",
        "descricao": "string",
        "descricaoMotivo": "string",
        "documentoGerador": "string",
        "decisao": "string",
        "prazo": "string",
        "descricaoPrazo": "string",
        "prazoTotal": "string",
        "descricaoPrazoTotal": "string",
        "recolhimentoCNH": "string",
        "ufDetran": "string",
        "orgaoResponsavel": "string"
      }
    ],
    "toxicologicoDataExame": "string",
    "toxicologicoDataValidade": "string",
    "cursos": [
      {
        "curso": {
          "tipo": "string",
          "descricaoTipo": "string",
          "classificacao": "string",
          "uf": "string",
          "data": "string"
        }
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/cnh2?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/cnhplus

Consulta dados da CNH com foto do condutor.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoCPF (somente números, 11 dígitos). 11 dígitos, somente números.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewCNHPlus

Campos da resposta 161 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
numeroRegistrostringSim
numeroFormularioRenachstringSim
numeroFormularioCnhstringSim
categoriaAtualstringSim
categoriaAutorizadastringSim
dataValidadestringSim
dataPrimeiraHabilitacaostringSim
dataUltimaEmissaostringSim
dataCadastramentostringSim
ufDominiostringSim
observacaostringSim
permissionadostringSim
situacaostringSim
situacaoAnteriorstringSim
cpfstringSim
nomestringSim
dataNascimentostringSim
tipoDocumentostringSim
documentostringSim
orgaoExpedidorstringSim
ufOrgaoExpedidorstringSim
nacionalidadestringSim
localNascimentostringSim
sexostringSim
nomeMaestringSim
nomePaistringSim
enderecostringSim
cancelamentostringSim
categoriaRebaixadastringSim
exerceAtividadeRemuneradastringSim
habilitacaoEstrangeiraobjectNão
registrostringSim
pais_origemstringSim
identificacaostringSim
validadestringSim
multasarray<MultaInfo>Sim
codigostringSim
descricaostringSim
quantidadestringSim
numeroListaImpedimentostringSim
numeroPgustringSim
quantidadeImpedimentosstringSim
requerimentosarray<string>Sim
restricoesMedicasstringSim
ufHabilitacaoAtualstringSim
ufPrimeiraHabilitacaostringSim
ufSolicitanteTransferenciastringSim
bloqueiosarray<Models_RetornoViews_RetornoViewCNHPlus_BloqueioInfo>Sim
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
toxicologicoDataExamestringSim
toxicologicoDataValidadestringSim
cursosobjectNão
tppobjectNão
classificacaostringSim
ufstringSim
datastringSim
teobjectNão
classificacaostringSim
ufstringSim
datastringSim
tcpobjectNão
classificacaostringSim
ufstringSim
datastringSim
tveobjectNão
classificacaostringSim
ufstringSim
datastringSim
tciobjectNão
classificacaostringSim
ufstringSim
datastringSim
tmfobjectNão
classificacaostringSim
ufstringSim
datastringSim
reciclagem_infratorobjectNão
ufstringSim
datastringSim
modalidadestringSim
atualizacao_cnhobjectNão
ufstringSim
datastringSim
modalidadestringSim
fotostringSim
nomeSocialstringSim
telefonestringSim
emailstringSim
filiacaoAfetivaMaestringSim
filiacaoAfetivaPaistringSim
dataInicioCategoriaobjectNão
astringSim
bstringSim
cstringSim
dstringSim
estringSim
cursoDetalhadoarray<CursoDetalhadoInfo>Sim
cursoDescricaostringSim
dataIniciostringSim
dataFimstringSim
cnpjEntidadestringSim
cargaHorariastringSim
categoriastringSim
modalidadestringSim
numeroCertificadostringSim
cpfInstrutorstringSim
municipiostringSim
dataValidadestringSim
observacoesstringSim
examesarray<ExameInfo>Sim
exameDescricaostringSim
dataExamestringSim
dataValidadestringSim
resultadostringSim
categoriaPretendidastringSim
categoriaPermitidastringSim
cpfExaminador1stringSim
cpfExaminador2stringSim
municipioExamestringSim
cnpjEntidadeCredenciadastringSim
observacoesstringSim
restricaostringSim
bloqueiosLiberadosarray<BloqueioLiberadoInfo>Sim
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
requisitosLiberacaoarray<string>Sim
orgaoResponsavelLiberacaostringSim
documentoLiberacaostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "numeroRegistro": "string",
    "numeroFormularioRenach": "string",
    "numeroFormularioCnh": "string",
    "categoriaAtual": "string",
    "categoriaAutorizada": "string",
    "dataValidade": "string",
    "dataPrimeiraHabilitacao": "string",
    "dataUltimaEmissao": "string",
    "dataCadastramento": "string",
    "ufDominio": "string",
    "observacao": "string",
    "permissionado": "string",
    "situacao": "string",
    "situacaoAnterior": "string",
    "cpf": "string",
    "nome": "string",
    "dataNascimento": "string",
    "tipoDocumento": "string",
    "documento": "string",
    "orgaoExpedidor": "string",
    "ufOrgaoExpedidor": "string",
    "nacionalidade": "string",
    "localNascimento": "string",
    "sexo": "string",
    "nomeMae": "string",
    "nomePai": "string",
    "endereco": "string",
    "cancelamento": "string",
    "categoriaRebaixada": "string",
    "exerceAtividadeRemunerada": "string",
    "habilitacaoEstrangeira": {
      "registro": "string",
      "pais_origem": "string",
      "identificacao": "string",
      "validade": "string"
    },
    "multas": [
      {
        "codigo": "string",
        "descricao": "string",
        "quantidade": "string"
      }
    ],
    "numeroListaImpedimento": "string",
    "numeroPgu": "string",
    "quantidadeImpedimentos": "string",
    "requerimentos": [
      "string"
    ],
    "restricoesMedicas": "string",
    "ufHabilitacaoAtual": "string",
    "ufPrimeiraHabilitacao": "string",
    "ufSolicitanteTransferencia": "string",
    "bloqueios": [
      {
        "mensagem": "string",
        "dataInicioPenalidade": "string",
        "dataTerminoPenalidade": "string",
        "descricao": "string",
        "descricaoMotivo": "string",
        "documentoGerador": "string",
        "decisao": "string",
        "prazo": "string",
        "descricaoPrazo": "string",
        "prazoTotal": "string",
        "descricaoPrazoTotal": "string",
        "recolhimentoCNH": "string",
        "ufDetran": "string",
        "orgaoResponsavel": "string"
      }
    ],
    "toxicologicoDataExame": "string",
    "toxicologicoDataValidade": "string",
    "cursos": {
      "tpp": {
        "classificacao": "string",
        "uf": "string",
        "data": "string"
      },
      "te": {
        "classificacao": "string",
        "uf": "string",
        "data": "string"
      },
      "tcp": {
        "classificacao": "string",
        "uf": "string",
        "data": "string"
      },
      "tve": {
        "classificacao": "string",
        "uf": "string",
        "data": "string"
      },
      "tci": {
        "classificacao": "string",
        "uf": "string",
        "data": "string"
      },
      "tmf": {
        "classificacao": "string",
        "uf": "string",
        "data": "string"
      },
      "reciclagem_infrator": {
        "uf": "string",
        "data": "string",
        "modalidade": "string"
      },
      "atualizacao_cnh": {
        "uf": "string",
        "data": "string",
        "modalidade": "string"
      }
    },
    "foto": "string",
    "nomeSocial": "string",
    "telefone": "string",
    "email": "string",
    "filiacaoAfetivaMae": "string",
    "filiacaoAfetivaPai": "string",
    "dataInicioCategoria": {
      "a": "string",
      "b": "string",
      "c": "string",
      "d": "string",
      "e": "string"
    },
    "cursoDetalhado": [
      {
        "cursoDescricao": "string",
        "dataInicio": "string",
        "dataFim": "string",
        "cnpjEntidade": "string",
        "cargaHoraria": "string",
        "categoria": "string",
        "modalidade": "string",
        "numeroCertificado": "string",
        "cpfInstrutor": "string",
        "municipio": "string",
        "dataValidade": "string",
        "observacoes": "string"
      }
    ],
    "exames": [
      {
        "exameDescricao": "string",
        "dataExame": "string",
        "dataValidade": "string",
        "resultado": "string",
        "categoriaPretendida": "string",
        "categoriaPermitida": "string",
        "cpfExaminador1": "string",
        "cpfExaminador2": "string",
        "municipioExame": "string",
        "cnpjEntidadeCredenciada": "string",
        "observacoes": "string",
        "restricao": "string"
      }
    ],
    "bloqueiosLiberados": [
      {
        "mensagem": "string",
        "dataInicioPenalidade": "string",
        "dataTerminoPenalidade": "string",
        "descricao": "string",
        "descricaoMotivo": "string",
        "documentoGerador": "string",
        "decisao": "string",
        "prazo": "string",
        "descricaoPrazo": "string",
        "prazoTotal": "string",
        "descricaoPrazoTotal": "string",
        "recolhimentoCNH": "string",
        "ufDetran": "string",
        "orgaoResponsavel": "string",
        "requisitosLiberacao": [
          "string"
        ],
        "orgaoResponsavelLiberacao": "string",
        "documentoLiberacao": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/cnhplus?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/FlagCNH

Verifica se o CPF possui CNH (flag sim/não).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cpfquerystringNãoCPF (somente números, 11 dígitos). 11 dígitos, somente números.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewFlagCNH

Campos da resposta 11 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
codigostringSim
possuiCNHbooleanNão
possuiCNHTextostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "92aae4fd-298d-441e-a7a1-afc171f4958b",
    "dataConsulta": "25/06/2026 15:00:46",
    "parametro": "00000000000",
    "usuario": "AvaliService",
    "tipoConsulta": "FlagCNH",
    "tempoTotalMs": 20235
  },
  "retorno": {
    "codigo": "200",
    "possuiCNH": true,
    "possuiCNHTexto": "SIM"
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/FlagCNH?cpf=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Pessoas e empresas

Dados cadastrais, crédito, protestos e processos judiciais de PF e PJ.

POST/api/Consultas/pfbasic

Pessoa física por CPF — dados cadastrais e pendências financeiras e comerciais (pacote Basic).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cpfquerystringNãoCPF (11 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewPfBasic

Campos da resposta 128 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastroobjectNão
cpfstringSim
nomestringSim
nomeMaestringSim
sexostringSim
dataNascimentostringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
pendenciasobjectNão
resumoGeralobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
dividasComerciaisobjectNão
registrosarray<RaDividaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasFinanceirasobjectNão
registrosarray<RaDividaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasVencidasobjectNão
registrosarray<RaDividaVencidaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
cidadestringSim
ufstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasProtestadasobjectNão
registrosarray<RaProtesto>Sim
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
chequeSemFundoobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
cobrancaobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
consultasAoDocumentoobjectNão
registrosarray<RaConsultaPf>Sim
datastringSim
quantidadeNoDiainteger (int32)Sim
segmentostringSim
resumoobjectNão
quantidadeinteger (int32)Não
consultasMesAtualinteger (int32)Não
consultasUltimos4Mesesinteger (int32)Não
historicoMensalarray<RaHistoricoMensal>Sim
mesReferenciastringSim
ocorrenciasinteger (int32)Não
documentosRoubadosobjectNão
registrosarray<RaDocumentoRoubado>Sim
datastringSim
descricaostringSim
resumoobjectNão
quantidadeinteger (int32)Não
participacoesSocietariasobjectNão
registrosarray<RaParticipacao>Sim
cnpjstringSim
razaoSocialstringSim
percentualCapitalnumber (double)Não
situacaoEmpresastringSim
ufEmpresastringSim
dataSituacaoEmpresastringSim
dataAtualizacaostringSim
dataInicioParticipacaostringSim
possuiAnotacaoNegativabooleanNão
resumoobjectNão
quantidadeinteger (int32)Não
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastro": {
      "cpf": "string",
      "nome": "string",
      "nomeMae": "string",
      "sexo": "string",
      "dataNascimento": "string",
      "situacaoCadastral": "string",
      "dataAtualizacaoSituacao": "string"
    },
    "pendencias": {
      "resumoGeral": {
        "quantidade": 0,
        "valorTotal": 0
      },
      "dividasComerciais": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "comarca": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasFinanceiras": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "comarca": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasVencidas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "cidade": "string",
            "uf": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasProtestadas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "cartorio": "string",
            "cidade": "string",
            "uf": "string",
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "chequeSemFundo": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "cobranca": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      }
    },
    "consultasAoDocumento": {
      "registros": [
        {
          "data": "string",
          "quantidadeNoDia": 0,
          "segmento": "string"
        }
      ],
      "resumo": {
        "quantidade": 0,
        "consultasMesAtual": 0,
        "consultasUltimos4Meses": 0
      },
      "historicoMensal": [
        {
          "mesReferencia": "string",
          "ocorrencias": 0
        }
      ]
    },
    "documentosRoubados": {
      "registros": [
        {
          "data": "string",
          "descricao": "string"
        }
      ],
      "resumo": {
        "quantidade": 0
      }
    },
    "participacoesSocietarias": {
      "registros": [
        {
          "cnpj": "string",
          "razaoSocial": "string",
          "percentualCapital": 0,
          "situacaoEmpresa": "string",
          "ufEmpresa": "string",
          "dataSituacaoEmpresa": "string",
          "dataAtualizacao": "string",
          "dataInicioParticipacao": "string",
          "possuiAnotacaoNegativa": false
        }
      ],
      "resumo": {
        "quantidade": 0
      }
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/pfbasic?cpf=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/pfmid

Pessoa física por CPF — cadastro, score de crédito e pendências (pacote Mid).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cpfquerystringNãoCPF (11 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewPfMid

Campos da resposta 134 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastroobjectNão
cpfstringSim
nomestringSim
nomeMaestringSim
sexostringSim
dataNascimentostringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
scoreobjectNão
pontuacaostringSim
modelostringSim
chancePagamentostringSim
pendenciasobjectNão
resumoGeralobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
dividasComerciaisobjectNão
registrosarray<RaDividaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasFinanceirasobjectNão
registrosarray<RaDividaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasVencidasobjectNão
registrosarray<RaDividaVencidaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
cidadestringSim
ufstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasProtestadasobjectNão
registrosarray<RaProtesto>Sim
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
chequeSemFundoobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
cobrancaobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
documentosRoubadosobjectNão
registrosarray<RaDocumentoRoubado>Sim
datastringSim
descricaostringSim
resumoobjectNão
quantidadeinteger (int32)Não
acoesJudiciaisobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
falenciasobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
participacoesSocietariasobjectNão
registrosarray<RaParticipacao>Sim
cnpjstringSim
razaoSocialstringSim
percentualCapitalnumber (double)Não
situacaoEmpresastringSim
ufEmpresastringSim
dataSituacaoEmpresastringSim
dataAtualizacaostringSim
dataInicioParticipacaostringSim
possuiAnotacaoNegativabooleanNão
resumoobjectNão
quantidadeinteger (int32)Não
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastro": {
      "cpf": "string",
      "nome": "string",
      "nomeMae": "string",
      "sexo": "string",
      "dataNascimento": "string",
      "situacaoCadastral": "string",
      "dataAtualizacaoSituacao": "string"
    },
    "score": {
      "pontuacao": "string",
      "modelo": "string",
      "chancePagamento": "string"
    },
    "pendencias": {
      "resumoGeral": {
        "quantidade": 0,
        "valorTotal": 0
      },
      "dividasComerciais": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "comarca": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasFinanceiras": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "comarca": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasVencidas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "cidade": "string",
            "uf": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasProtestadas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "cartorio": "string",
            "cidade": "string",
            "uf": "string",
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "chequeSemFundo": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "cobranca": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      }
    },
    "documentosRoubados": {
      "registros": [
        {
          "data": "string",
          "descricao": "string"
        }
      ],
      "resumo": {
        "quantidade": 0
      }
    },
    "acoesJudiciais": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "falencias": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "participacoesSocietarias": {
      "registros": [
        {
          "cnpj": "string",
          "razaoSocial": "string",
          "percentualCapital": 0,
          "situacaoEmpresa": "string",
          "ufEmpresa": "string",
          "dataSituacaoEmpresa": "string",
          "dataAtualizacao": "string",
          "dataInicioParticipacao": "string",
          "possuiAnotacaoNegativa": false
        }
      ],
      "resumo": {
        "quantidade": 0
      }
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/pfmid?cpf=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/pfmaster

Pessoa física por CPF — cadastro completo com endereços e telefones, informações complementares, score e pendências (pacote Master).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cpfquerystringNãoCPF (11 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewPfMaster

Campos da resposta 185 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastroobjectNão
cpfstringSim
nomestringSim
nomeMaestringSim
sexostringSim
dataNascimentostringSim
idadestringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
municipioUfstringSim
enderecosarray<RaEnderecoPf>Sim
enderecostringSim
prioridadestringSim
dataAtualizacaostringSim
telefonesarray<RaTelefonePf>Sim
telefonestringSim
prioridadestringSim
tipostringSim
dataAtualizacaostringSim
informacoesComplementaresobjectNão
orgaoEmissorstringSim
ufEmissaostringSim
dataEmissaostringSim
cidadeNascimentostringSim
ufNascimentostringSim
estadoCivilstringSim
dependentesstringSim
escolaridadestringSim
ocupacaostringSim
profissaostringSim
cargostringSim
nomeEmpresastringSim
cnpjEmpresastringSim
scoreobjectNão
pontuacaostringSim
modelostringSim
chancePagamentostringSim
pendenciasobjectNão
resumoGeralobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
dividasComerciaisobjectNão
registrosarray<RaDividaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasFinanceirasobjectNão
registrosarray<RaDividaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasVencidasobjectNão
registrosarray<RaDividaVencidaPf>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
cidadestringSim
ufstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasProtestadasobjectNão
registrosarray<RaProtesto>Sim
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
chequeSemFundoobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
cobrancaobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
consultasAoDocumentoobjectNão
registrosarray<RaConsultaPf>Sim
datastringSim
quantidadeNoDiainteger (int32)Sim
segmentostringSim
resumoobjectNão
quantidadeinteger (int32)Não
consultasMesAtualinteger (int32)Não
consultasUltimos4Mesesinteger (int32)Não
historicoMensalarray<RaHistoricoMensal>Sim
mesReferenciastringSim
ocorrenciasinteger (int32)Não
documentosRoubadosobjectNão
registrosarray<RaDocumentoRoubado>Sim
datastringSim
descricaostringSim
resumoobjectNão
quantidadeinteger (int32)Não
acoesJudiciaisobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
falenciasobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
participacoesSocietariasobjectNão
registrosarray<RaParticipacao>Sim
cnpjstringSim
razaoSocialstringSim
percentualCapitalnumber (double)Não
situacaoEmpresastringSim
ufEmpresastringSim
dataSituacaoEmpresastringSim
dataAtualizacaostringSim
dataInicioParticipacaostringSim
possuiAnotacaoNegativabooleanNão
resumoobjectNão
quantidadeinteger (int32)Não
chequesSustadosobjectNão
registrosarray<RaChequeSustado>Sim
titularstringSim
bancostringSim
codigoBancointeger (int32)Sim
agenciainteger (int32)Sim
contastringSim
chequeInicialstringSim
chequeFinalstringSim
valorChequenumber (double)Não
motivostringSim
dataHoraInclusaostringSim
mensagemstringSim
quantidadeChequesinteger (int32)Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastro": {
      "cpf": "string",
      "nome": "string",
      "nomeMae": "string",
      "sexo": "string",
      "dataNascimento": "string",
      "idade": "string",
      "situacaoCadastral": "string",
      "dataAtualizacaoSituacao": "string",
      "municipioUf": "string",
      "enderecos": [
        {
          "endereco": "string",
          "prioridade": "string",
          "dataAtualizacao": "string"
        }
      ],
      "telefones": [
        {
          "telefone": "string",
          "prioridade": "string",
          "tipo": "string",
          "dataAtualizacao": "string"
        }
      ]
    },
    "informacoesComplementares": {
      "orgaoEmissor": "string",
      "ufEmissao": "string",
      "dataEmissao": "string",
      "cidadeNascimento": "string",
      "ufNascimento": "string",
      "estadoCivil": "string",
      "dependentes": "string",
      "escolaridade": "string",
      "ocupacao": "string",
      "profissao": "string",
      "cargo": "string",
      "nomeEmpresa": "string",
      "cnpjEmpresa": "string"
    },
    "score": {
      "pontuacao": "string",
      "modelo": "string",
      "chancePagamento": "string"
    },
    "pendencias": {
      "resumoGeral": {
        "quantidade": 0,
        "valorTotal": 0
      },
      "dividasComerciais": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "comarca": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasFinanceiras": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "comarca": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasVencidas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "cidade": "string",
            "uf": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasProtestadas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "cartorio": "string",
            "cidade": "string",
            "uf": "string",
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "chequeSemFundo": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "cobranca": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      }
    },
    "consultasAoDocumento": {
      "registros": [
        {
          "data": "string",
          "quantidadeNoDia": 0,
          "segmento": "string"
        }
      ],
      "resumo": {
        "quantidade": 0,
        "consultasMesAtual": 0,
        "consultasUltimos4Meses": 0
      },
      "historicoMensal": [
        {
          "mesReferencia": "string",
          "ocorrencias": 0
        }
      ]
    },
    "documentosRoubados": {
      "registros": [
        {
          "data": "string",
          "descricao": "string"
        }
      ],
      "resumo": {
        "quantidade": 0
      }
    },
    "acoesJudiciais": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "falencias": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "participacoesSocietarias": {
      "registros": [
        {
          "cnpj": "string",
          "razaoSocial": "string",
          "percentualCapital": 0,
          "situacaoEmpresa": "string",
          "ufEmpresa": "string",
          "dataSituacaoEmpresa": "string",
          "dataAtualizacao": "string",
          "dataInicioParticipacao": "string",
          "possuiAnotacaoNegativa": false
        }
      ],
      "resumo": {
        "quantidade": 0
      }
    },
    "chequesSustados": {
      "registros": [
        {
          "titular": "string",
          "banco": "string",
          "codigoBanco": 0,
          "agencia": 0,
          "conta": "string",
          "chequeInicial": "string",
          "chequeFinal": "string",
          "valorCheque": 0,
          "motivo": "string",
          "dataHoraInclusao": "string",
          "mensagem": "string",
          "quantidadeCheques": 0
        }
      ]
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/pfmaster?cpf=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/pjbasic

Pessoa jurídica por CNPJ — cadastro, pendências, cheques sem fundo, consultas ao documento, quadro societário e diretoria (pacote Basic).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cnpjquerystringNãoCNPJ (14 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewPjBasic

Campos da resposta 120 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastroobjectNão
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
situacaoCadastralstringSim
enderecostringSim
pendenciasobjectNão
resumoGeralobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
dividasComerciaisobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasFinanceirasobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasVencidasobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasProtestadasobjectNão
registrosarray<RaProtesto>Sim
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
chequeSemFundoobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
cobrancaobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
consultasAoDocumentoobjectNão
registrosarray<RaConsultaPj>Sim
datastringSim
razaoSocialConsultantestringSim
documentoConsultantestringSim
quantidadeNoDiainteger (int32)Sim
resumoobjectNão
quantidadeinteger (int32)Não
consultasMesAtualinteger (int32)Não
consultasUltimos13Mesesinteger (int32)Não
historicoMensalarray<RaHistoricoMensal>Sim
mesReferenciastringSim
ocorrenciasinteger (int32)Não
quadroSocietarioobjectNão
registrosarray<RaMembroSimples>Sim
documentostringSim
nomestringSim
situacaostringSim
percentualCapitalnumber (double)Sim
cargostringSim
possuiAnotacaoNegativabooleanNão
diretoriaobjectNão
registrosarray<RaMembroSimples>Sim
documentostringSim
nomestringSim
situacaostringSim
percentualCapitalnumber (double)Sim
cargostringSim
possuiAnotacaoNegativabooleanNão
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastro": {
      "cnpj": "string",
      "razaoSocial": "string",
      "dataFundacao": "string",
      "situacaoCadastral": "string",
      "endereco": "string"
    },
    "pendencias": {
      "resumoGeral": {
        "quantidade": 0,
        "valorTotal": 0
      },
      "dividasComerciais": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasFinanceiras": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasVencidas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasProtestadas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "cartorio": "string",
            "cidade": "string",
            "uf": "string",
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "chequeSemFundo": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "cobranca": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      }
    },
    "consultasAoDocumento": {
      "registros": [
        {
          "data": "string",
          "razaoSocialConsultante": "string",
          "documentoConsultante": "string",
          "quantidadeNoDia": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "consultasMesAtual": 0,
        "consultasUltimos13Meses": 0
      },
      "historicoMensal": [
        {
          "mesReferencia": "string",
          "ocorrencias": 0
        }
      ]
    },
    "quadroSocietario": {
      "registros": [
        {
          "documento": "string",
          "nome": "string",
          "situacao": "string",
          "percentualCapital": 0,
          "cargo": "string",
          "possuiAnotacaoNegativa": false
        }
      ]
    },
    "diretoria": {
      "registros": [
        {
          "documento": "string",
          "nome": "string",
          "situacao": "string",
          "percentualCapital": 0,
          "cargo": "string",
          "possuiAnotacaoNegativa": false
        }
      ]
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/pjbasic?cnpj=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/pjmid

Pessoa jurídica por CNPJ — cadastro, score, pendências, ações judiciais e falências (pacote Mid).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cnpjquerystringNãoCNPJ (14 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewPjMid

Campos da resposta 127 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastroobjectNão
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
enderecostringSim
scoreobjectNão
pontuacaostringSim
modelostringSim
probabilidadeInadimplenciastringSim
faturamentoDisponivelbooleanSim
pendenciasobjectNão
resumoGeralobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
dividasComerciaisobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasFinanceirasobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasVencidasobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasProtestadasobjectNão
registrosarray<RaProtesto>Sim
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
chequeSemFundoobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
cobrancaobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
acoesJudiciaisobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
falenciasobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
quadroSocietarioobjectNão
registrosarray<RaMembroSimples>Sim
documentostringSim
nomestringSim
situacaostringSim
percentualCapitalnumber (double)Sim
cargostringSim
possuiAnotacaoNegativabooleanNão
diretoriaobjectNão
registrosarray<RaMembroSimples>Sim
documentostringSim
nomestringSim
situacaostringSim
percentualCapitalnumber (double)Sim
cargostringSim
possuiAnotacaoNegativabooleanNão
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastro": {
      "cnpj": "string",
      "razaoSocial": "string",
      "dataFundacao": "string",
      "situacaoCadastral": "string",
      "dataAtualizacaoSituacao": "string",
      "endereco": "string"
    },
    "score": {
      "pontuacao": "string",
      "modelo": "string",
      "probabilidadeInadimplencia": "string",
      "faturamentoDisponivel": false
    },
    "pendencias": {
      "resumoGeral": {
        "quantidade": 0,
        "valorTotal": 0
      },
      "dividasComerciais": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasFinanceiras": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasVencidas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasProtestadas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "cartorio": "string",
            "cidade": "string",
            "uf": "string",
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "chequeSemFundo": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "cobranca": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      }
    },
    "acoesJudiciais": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "falencias": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "quadroSocietario": {
      "registros": [
        {
          "documento": "string",
          "nome": "string",
          "situacao": "string",
          "percentualCapital": 0,
          "cargo": "string",
          "possuiAnotacaoNegativa": false
        }
      ]
    },
    "diretoria": {
      "registros": [
        {
          "documento": "string",
          "nome": "string",
          "situacao": "string",
          "percentualCapital": 0,
          "cargo": "string",
          "possuiAnotacaoNegativa": false
        }
      ]
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/pjmid?cnpj=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/pjmaster

Pessoa jurídica por CNPJ — cadastro completo (CNAE, tributação, filiais), score e pendências (pacote Master).

Parâmetros

NomeOndeTipoObrigatórioDescrição
cnpjquerystringNãoCNPJ (14 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewPjMaster

Campos da resposta 187 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastroobjectNão
cnpjstringSim
dataAtualizacaostringSim
situacaoCadastralstringSim
razaoSocialstringSim
nomeFantasiastringSim
dataFundacaostringSim
idadeEmpresastringSim
municipioUfstringSim
ramoAtividadestringSim
tipoSociedadestringSim
numeroFuncionariosstringSim
quantidadeFiliaisinteger (int32)Sim
opcaoTributariastringSim
enderecostringSim
sitestringSim
telefonestringSim
cnaestringSim
atividadeEconomicastringSim
inscricaoEstadualstringSim
nirestringSim
numeroRegistrostringSim
dataRegistrostringSim
percentualImportacaoComprasstringSim
percentualExportacaoVendasstringSim
codigoAtividadestringSim
empresaAntecessorastringSim
quadroSocietarioCompletoobjectNão
capitalSocialnumber (double)Não
capitalRealizadonumber (double)Não
dataAtualizacaostringSim
paisOrigemstringSim
tipoControlestringSim
tipoCapitalstringSim
resumoAnotacoesobjectNão
sociosinteger (int32)Não
administradoresinteger (int32)Não
sociosarray<RaSocioCompleto>Sim
documentostringSim
nomestringSim
percentualCapitalnumber (double)Não
percentualCapitalVotantenumber (double)Não
dataEntradastringSim
nacionalidadestringSim
possuiAnotacaoNegativabooleanNão
administradoresarray<RaAdministradorCompleto>Sim
documentostringSim
nomestringSim
cargostringSim
dataEntradastringSim
mandatostringSim
nacionalidadestringSim
estadoCivilstringSim
possuiAnotacaoNegativabooleanNão
scoreobjectNão
pontuacaostringSim
modelostringSim
classificacaoRiscostringSim
probabilidadeInadimplenciastringSim
riscoCreditostringSim
praticaMercadoRecomendadastringSim
pendenciasobjectNão
resumoGeralobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
dividasComerciaisobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasFinanceirasobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasVencidasobjectNão
registrosarray<RaDividaPj>Sim
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
dividasProtestadasobjectNão
registrosarray<RaProtesto>Sim
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
chequeSemFundoobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
cobrancaobjectNão
registrosarray<RaDataValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
acoesJudiciaisobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
falenciasobjectNão
registrosarray<RaAcaoValor>Sim
datastringSim
valornumber (double)Não
resumoobjectNão
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
consultasAoDocumentoobjectNão
registrosarray<RaConsultaPj>Sim
datastringSim
razaoSocialConsultantestringSim
documentoConsultantestringSim
quantidadeNoDiainteger (int32)Sim
resumoobjectNão
quantidadeinteger (int32)Não
consultasMesAtualinteger (int32)Não
consultasUltimos13Mesesinteger (int32)Não
historicoMensalarray<RaHistoricoMensal>Sim
mesReferenciastringSim
ocorrenciasinteger (int32)Não
chequesSustadosobjectNão
registrosarray<RaChequeSustado>Sim
titularstringSim
bancostringSim
codigoBancointeger (int32)Sim
agenciainteger (int32)Sim
contastringSim
chequeInicialstringSim
chequeFinalstringSim
valorChequenumber (double)Não
motivostringSim
dataHoraInclusaostringSim
mensagemstringSim
quantidadeChequesinteger (int32)Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastro": {
      "cnpj": "string",
      "dataAtualizacao": "string",
      "situacaoCadastral": "string",
      "razaoSocial": "string",
      "nomeFantasia": "string",
      "dataFundacao": "string",
      "idadeEmpresa": "string",
      "municipioUf": "string",
      "ramoAtividade": "string",
      "tipoSociedade": "string",
      "numeroFuncionarios": "string",
      "quantidadeFiliais": 0,
      "opcaoTributaria": "string",
      "endereco": "string",
      "site": "string",
      "telefone": "string",
      "cnae": "string",
      "atividadeEconomica": "string",
      "inscricaoEstadual": "string",
      "nire": "string",
      "numeroRegistro": "string",
      "dataRegistro": "string",
      "percentualImportacaoCompras": "string",
      "percentualExportacaoVendas": "string",
      "codigoAtividade": "string",
      "empresaAntecessora": "string"
    },
    "quadroSocietarioCompleto": {
      "capitalSocial": 0,
      "capitalRealizado": 0,
      "dataAtualizacao": "string",
      "paisOrigem": "string",
      "tipoControle": "string",
      "tipoCapital": "string",
      "resumoAnotacoes": {
        "socios": 0,
        "administradores": 0
      },
      "socios": [
        {
          "documento": "string",
          "nome": "string",
          "percentualCapital": 0,
          "percentualCapitalVotante": 0,
          "dataEntrada": "string",
          "nacionalidade": "string",
          "possuiAnotacaoNegativa": false
        }
      ],
      "administradores": [
        {
          "documento": "string",
          "nome": "string",
          "cargo": "string",
          "dataEntrada": "string",
          "mandato": "string",
          "nacionalidade": "string",
          "estadoCivil": "string",
          "possuiAnotacaoNegativa": false
        }
      ]
    },
    "score": {
      "pontuacao": "string",
      "modelo": "string",
      "classificacaoRisco": "string",
      "probabilidadeInadimplencia": "string",
      "riscoCredito": "string",
      "praticaMercadoRecomendada": "string"
    },
    "pendencias": {
      "resumoGeral": {
        "quantidade": 0,
        "valorTotal": 0
      },
      "dividasComerciais": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasFinanceiras": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasVencidas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "modalidade": "string",
            "numeroContrato": "string",
            "credor": "string",
            "avalista": false,
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "dividasProtestadas": {
        "registros": [
          {
            "data": "string",
            "valor": 0,
            "cartorio": "string",
            "cidade": "string",
            "uf": "string",
            "codigoOcorrencia": "string"
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "chequeSemFundo": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      },
      "cobranca": {
        "registros": [
          {
            "data": "string",
            "valor": 0
          }
        ],
        "resumo": {
          "quantidade": 0,
          "valorTotal": 0,
          "primeiraOcorrencia": "string",
          "ultimaOcorrencia": "string"
        }
      }
    },
    "acoesJudiciais": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "falencias": {
      "registros": [
        {
          "data": "string",
          "valor": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "valorTotal": 0
      }
    },
    "consultasAoDocumento": {
      "registros": [
        {
          "data": "string",
          "razaoSocialConsultante": "string",
          "documentoConsultante": "string",
          "quantidadeNoDia": 0
        }
      ],
      "resumo": {
        "quantidade": 0,
        "consultasMesAtual": 0,
        "consultasUltimos13Meses": 0
      },
      "historicoMensal": [
        {
          "mesReferencia": "string",
          "ocorrencias": 0
        }
      ]
    },
    "chequesSustados": {
      "registros": [
        {
          "titular": "string",
          "banco": "string",
          "codigoBanco": 0,
          "agencia": 0,
          "conta": "string",
          "chequeInicial": "string",
          "chequeFinal": "string",
          "valorCheque": 0,
          "motivo": "string",
          "dataHoraInclusao": "string",
          "mensagem": "string",
          "quantidadeCheques": 0
        }
      ]
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/pjmaster?cnpj=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/protestopf

Consulta protestos em cartório por CPF — quantidade, valores, cartórios e apresentantes.

Parâmetros

NomeOndeTipoObrigatórioDescrição
cpfquerystringNãoCPF (11 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewProtesto

Campos da resposta 24 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
documentostringSim
tipoDocumentostringSim
possuiProtestobooleanSim
quantidadeProtestosinteger (int32)Sim
totalRegistrosinteger (int32)Sim
protestosarray<ProtestoDetalhe>Sim
ufstringSim
municipiostringSim
cartoriostringSim
telefoneCartoriostringSim
dataProtestostringSim
vencimentostringSim
valorProtestadostringSim
valorTitulostringSim
apresentantestringSim
cedentestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "documento": "string",
    "tipoDocumento": "string",
    "possuiProtesto": false,
    "quantidadeProtestos": 0,
    "totalRegistros": 0,
    "protestos": [
      {
        "uf": "string",
        "municipio": "string",
        "cartorio": "string",
        "telefoneCartorio": "string",
        "dataProtesto": "string",
        "vencimento": "string",
        "valorProtestado": "string",
        "valorTitulo": "string",
        "apresentante": "string",
        "cedente": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/protestopf?cpf=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Consultas/protestopj

Consulta protestos em cartório por CNPJ — quantidade, valores, cartórios e apresentantes.

Parâmetros

NomeOndeTipoObrigatórioDescrição
cnpjquerystringNãoCNPJ (14 dígitos, apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewProtesto

Campos da resposta 24 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
documentostringSim
tipoDocumentostringSim
possuiProtestobooleanSim
quantidadeProtestosinteger (int32)Sim
totalRegistrosinteger (int32)Sim
protestosarray<ProtestoDetalhe>Sim
ufstringSim
municipiostringSim
cartoriostringSim
telefoneCartoriostringSim
dataProtestostringSim
vencimentostringSim
valorProtestadostringSim
valorTitulostringSim
apresentantestringSim
cedentestringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "documento": "string",
    "tipoDocumento": "string",
    "possuiProtesto": false,
    "quantidadeProtestos": 0,
    "totalRegistros": 0,
    "protestos": [
      {
        "uf": "string",
        "municipio": "string",
        "cartorio": "string",
        "telefoneCartorio": "string",
        "dataProtesto": "string",
        "vencimento": "string",
        "valorProtestado": "string",
        "valorTitulo": "string",
        "apresentante": "string",
        "cedente": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Consultas/protestopj?cnpj=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/dadospf

Consulta cadastral completa de pessoa física por CPF — endereços, telefones, e-mails, participações societárias, vínculos e indicadores.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfDadosPfView

Campos da resposta 68 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastraisobjectNão
documentostringSim
nomestringSim
nascimentostringSim
sexostringSim
nomeMaestringSim
signostringSim
idadestringSim
moradoresEnderecoarray<MoradorView>Sim
cpfstringSim
nomestringSim
enderecosarray<EnderecoView>Sim
tipoLogradourostringSim
logradourostringSim
numerostringSim
complementostringSim
bairrostringSim
cidadestringSim
ufstringSim
cepstringSim
telefonesarray<TelefoneView>Sim
tipostringSim
whatsappstringSim
dddstringSim
numerostringSim
participacaoSocietariaarray<ParticipacaoView>Sim
cnpjstringSim
razaoSocialstringSim
documentostringSim
percentualstringSim
datastringSim
qualificacaostringSim
rendaIbgestringSim
emailsarray<string>Sim
bolsaFamiliastringSim
vinculosarray<VinculoView>Sim
cpfstringSim
nomestringSim
grauVinculostringSim
esportistaobjectNão
esportistastringSim
apelidostringSim
modalidadestringSim
funcaostringSim
nomestringSim
equipestringSim
paisstringSim
parentescostringSim
grauVinculostringSim
pepobjectNão
pepstringSim
nomestringSim
funcaostringSim
nivelstringSim
orgaostringSim
dataIniciostringSim
dataFimstringSim
dataFimCarenciastringSim
parentescostringSim
grauVinculostringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastrais": {
      "documento": "string",
      "nome": "string",
      "nascimento": "string",
      "sexo": "string",
      "nomeMae": "string",
      "signo": "string",
      "idade": "string"
    },
    "moradoresEndereco": [
      {
        "cpf": "string",
        "nome": "string"
      }
    ],
    "enderecos": [
      {
        "tipoLogradouro": "string",
        "logradouro": "string",
        "numero": "string",
        "complemento": "string",
        "bairro": "string",
        "cidade": "string",
        "uf": "string",
        "cep": "string"
      }
    ],
    "telefones": [
      {
        "tipo": "string",
        "whatsapp": "string",
        "ddd": "string",
        "numero": "string"
      }
    ],
    "participacaoSocietaria": [
      {
        "cnpj": "string",
        "razaoSocial": "string",
        "documento": "string",
        "percentual": "string",
        "data": "string",
        "qualificacao": "string"
      }
    ],
    "rendaIbge": "string",
    "emails": [
      "string"
    ],
    "bolsaFamilia": "string",
    "vinculos": [
      {
        "cpf": "string",
        "nome": "string",
        "grauVinculo": "string"
      }
    ],
    "esportista": {
      "esportista": "string",
      "apelido": "string",
      "modalidade": "string",
      "funcao": "string",
      "nome": "string",
      "equipe": "string",
      "pais": "string",
      "parentesco": "string",
      "grauVinculo": "string"
    },
    "pep": {
      "pep": "string",
      "nome": "string",
      "funcao": "string",
      "nivel": "string",
      "orgao": "string",
      "dataInicio": "string",
      "dataFim": "string",
      "dataFimCarencia": "string",
      "parentesco": "string",
      "grauVinculo": "string"
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/dadospf?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/dadospj

Consulta cadastral completa de pessoa jurídica por CNPJ — endereços, telefones, quadro societário, CNAE, filiais e participações.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfDadosPjView

Campos da resposta 66 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
cadastraisobjectNão
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
nomeFantasiastringSim
codigoNaturezastringSim
descricaoNaturezastringSim
enderecosarray<EnderecoView>Sim
tipoLogradourostringSim
logradourostringSim
numerostringSim
complementostringSim
bairrostringSim
cidadestringSim
ufstringSim
cepstringSim
telefonesarray<TelefoneView>Sim
tipostringSim
whatsappstringSim
dddstringSim
numerostringSim
quadroSocietarioarray<SocioView>Sim
documentoEmpresastringSim
razaoSocialEmpresastringSim
documentostringSim
nomestringSim
qualificacaostringSim
qualificacaoGlobalstringSim
percentualstringSim
datastringSim
cnaearray<CnaeView>Sim
codigostringSim
descricaostringSim
participacaoSocietariaarray<ParticipacaoView>Sim
cnpjstringSim
razaoSocialstringSim
documentostringSim
percentualstringSim
datastringSim
qualificacaostringSim
infoEmpresaobjectNão
numeroFuncionariosstringSim
portestringSim
faturamentostringSim
filiaisstringSim
capitalSocialstringSim
filiaisarray<FilialView>Sim
quantidadestringSim
ativastringSim
inaptastringSim
suspensastringSim
baixadastringSim
nulastringSim
matrizarray<MatrizView>Sim
cnpjstringSim
condicaostringSim
matrizstringSim
emailsarray<string>Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "cadastrais": {
      "cnpj": "string",
      "razaoSocial": "string",
      "dataFundacao": "string",
      "nomeFantasia": "string",
      "codigoNatureza": "string",
      "descricaoNatureza": "string"
    },
    "enderecos": [
      {
        "tipoLogradouro": "string",
        "logradouro": "string",
        "numero": "string",
        "complemento": "string",
        "bairro": "string",
        "cidade": "string",
        "uf": "string",
        "cep": "string"
      }
    ],
    "telefones": [
      {
        "tipo": "string",
        "whatsapp": "string",
        "ddd": "string",
        "numero": "string"
      }
    ],
    "quadroSocietario": [
      {
        "documentoEmpresa": "string",
        "razaoSocialEmpresa": "string",
        "documento": "string",
        "nome": "string",
        "qualificacao": "string",
        "qualificacaoGlobal": "string",
        "percentual": "string",
        "data": "string"
      }
    ],
    "cnae": [
      {
        "codigo": "string",
        "descricao": "string"
      }
    ],
    "participacaoSocietaria": [
      {
        "cnpj": "string",
        "razaoSocial": "string",
        "documento": "string",
        "percentual": "string",
        "data": "string",
        "qualificacao": "string"
      }
    ],
    "infoEmpresa": {
      "numeroFuncionarios": "string",
      "porte": "string",
      "faturamento": "string",
      "filiais": "string",
      "capitalSocial": "string"
    },
    "filiais": [
      {
        "quantidade": "string",
        "ativa": "string",
        "inapta": "string",
        "suspensa": "string",
        "baixada": "string",
        "nula": "string"
      }
    ],
    "matriz": [
      {
        "cnpj": "string",
        "condicao": "string",
        "matriz": "string"
      }
    ],
    "emails": [
      "string"
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/dadospj?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/dadosplacapfpj

Consulta cadastral pela placa — retorna o veículo e os dados de pessoa física ou jurídica vinculados.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoPlaca (ABC1D23 / ABC1234) ou chassi (17 caracteres) do veículo. Aceita placa (7 caracteres) ou chassi (17 caracteres).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDadosPlacaPfPj

Campos da resposta 137 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
veiculoobjectNão
placastringSim
marcaModelostringSim
corstringSim
chassistringSim
anoModelostringSim
anoFabricacaostringSim
nomeProprietariostringSim
documentoProprietariostringSim
dadosPfobjectNão
cadastraisobjectNão
documentostringSim
nomestringSim
nascimentostringSim
sexostringSim
nomeMaestringSim
signostringSim
idadestringSim
moradoresEnderecoarray<MoradorView>Sim
cpfstringSim
nomestringSim
enderecosarray<EnderecoView>Sim
tipoLogradourostringSim
logradourostringSim
numerostringSim
complementostringSim
bairrostringSim
cidadestringSim
ufstringSim
cepstringSim
telefonesarray<TelefoneView>Sim
tipostringSim
whatsappstringSim
dddstringSim
numerostringSim
participacaoSocietariaarray<ParticipacaoView>Sim
cnpjstringSim
razaoSocialstringSim
documentostringSim
percentualstringSim
datastringSim
qualificacaostringSim
rendaIbgestringSim
emailsarray<string>Sim
bolsaFamiliastringSim
vinculosarray<VinculoView>Sim
cpfstringSim
nomestringSim
grauVinculostringSim
esportistaobjectNão
esportistastringSim
apelidostringSim
modalidadestringSim
funcaostringSim
nomestringSim
equipestringSim
paisstringSim
parentescostringSim
grauVinculostringSim
pepobjectNão
pepstringSim
nomestringSim
funcaostringSim
nivelstringSim
orgaostringSim
dataIniciostringSim
dataFimstringSim
dataFimCarenciastringSim
parentescostringSim
grauVinculostringSim
dadosPjobjectNão
cadastraisobjectNão
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
nomeFantasiastringSim
codigoNaturezastringSim
descricaoNaturezastringSim
enderecosarray<EnderecoView>Sim
tipoLogradourostringSim
logradourostringSim
numerostringSim
complementostringSim
bairrostringSim
cidadestringSim
ufstringSim
cepstringSim
telefonesarray<TelefoneView>Sim
tipostringSim
whatsappstringSim
dddstringSim
numerostringSim
quadroSocietarioarray<SocioView>Sim
documentoEmpresastringSim
razaoSocialEmpresastringSim
documentostringSim
nomestringSim
qualificacaostringSim
qualificacaoGlobalstringSim
percentualstringSim
datastringSim
cnaearray<CnaeView>Sim
codigostringSim
descricaostringSim
participacaoSocietariaarray<ParticipacaoView>Sim
cnpjstringSim
razaoSocialstringSim
documentostringSim
percentualstringSim
datastringSim
qualificacaostringSim
infoEmpresaobjectNão
numeroFuncionariosstringSim
portestringSim
faturamentostringSim
filiaisstringSim
capitalSocialstringSim
filiaisarray<FilialView>Sim
quantidadestringSim
ativastringSim
inaptastringSim
suspensastringSim
baixadastringSim
nulastringSim
matrizarray<MatrizView>Sim
cnpjstringSim
condicaostringSim
matrizstringSim
emailsarray<string>Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "veiculo": {
      "placa": "string",
      "marcaModelo": "string",
      "cor": "string",
      "chassi": "string",
      "anoModelo": "string",
      "anoFabricacao": "string",
      "nomeProprietario": "string",
      "documentoProprietario": "string"
    },
    "dadosPf": {
      "cadastrais": {
        "documento": "string",
        "nome": "string",
        "nascimento": "string",
        "sexo": "string",
        "nomeMae": "string",
        "signo": "string",
        "idade": "string"
      },
      "moradoresEndereco": [
        {
          "cpf": "string",
          "nome": "string"
        }
      ],
      "enderecos": [
        {
          "tipoLogradouro": "string",
          "logradouro": "string",
          "numero": "string",
          "complemento": "string",
          "bairro": "string",
          "cidade": "string",
          "uf": "string",
          "cep": "string"
        }
      ],
      "telefones": [
        {
          "tipo": "string",
          "whatsapp": "string",
          "ddd": "string",
          "numero": "string"
        }
      ],
      "participacaoSocietaria": [
        {
          "cnpj": "string",
          "razaoSocial": "string",
          "documento": "string",
          "percentual": "string",
          "data": "string",
          "qualificacao": "string"
        }
      ],
      "rendaIbge": "string",
      "emails": [
        "string"
      ],
      "bolsaFamilia": "string",
      "vinculos": [
        {
          "cpf": "string",
          "nome": "string",
          "grauVinculo": "string"
        }
      ],
      "esportista": {
        "esportista": "string",
        "apelido": "string",
        "modalidade": "string",
        "funcao": "string",
        "nome": "string",
        "equipe": "string",
        "pais": "string",
        "parentesco": "string",
        "grauVinculo": "string"
      },
      "pep": {
        "pep": "string",
        "nome": "string",
        "funcao": "string",
        "nivel": "string",
        "orgao": "string",
        "dataInicio": "string",
        "dataFim": "string",
        "dataFimCarencia": "string",
        "parentesco": "string",
        "grauVinculo": "string"
      }
    },
    "dadosPj": {
      "cadastrais": {
        "cnpj": "string",
        "razaoSocial": "string",
        "dataFundacao": "string",
        "nomeFantasia": "string",
        "codigoNatureza": "string",
        "descricaoNatureza": "string"
      },
      "enderecos": [
        {
          "tipoLogradouro": "string",
          "logradouro": "string",
          "numero": "string",
          "complemento": "string",
          "bairro": "string",
          "cidade": "string",
          "uf": "string",
          "cep": "string"
        }
      ],
      "telefones": [
        {
          "tipo": "string",
          "whatsapp": "string",
          "ddd": "string",
          "numero": "string"
        }
      ],
      "quadroSocietario": [
        {
          "documentoEmpresa": "string",
          "razaoSocialEmpresa": "string",
          "documento": "string",
          "nome": "string",
          "qualificacao": "string",
          "qualificacaoGlobal": "string",
          "percentual": "string",
          "data": "string"
        }
      ],
      "cnae": [
        {
          "codigo": "string",
          "descricao": "string"
        }
      ],
      "participacaoSocietaria": [
        {
          "cnpj": "string",
          "razaoSocial": "string",
          "documento": "string",
          "percentual": "string",
          "data": "string",
          "qualificacao": "string"
        }
      ],
      "infoEmpresa": {
        "numeroFuncionarios": "string",
        "porte": "string",
        "faturamento": "string",
        "filiais": "string",
        "capitalSocial": "string"
      },
      "filiais": [
        {
          "quantidade": "string",
          "ativa": "string",
          "inapta": "string",
          "suspensa": "string",
          "baixada": "string",
          "nula": "string"
        }
      ],
      "matriz": [
        {
          "cnpj": "string",
          "condicao": "string",
          "matriz": "string"
        }
      ],
      "emails": [
        "string"
      ]
    }
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/dadosplacapfpj?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/processos

Processos judiciais por CPF ou CNPJ — contagem e lista com tribunal, classe, partes e julgamentos.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoCPF ou CNPJ (apenas números).

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewProcessos

Campos da resposta 36 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
nomeRazaostringSim
documentostringSim
nomeFantasiastringSim
fundacaostringSim
naturezastringSim
contagemstringSim
processosarray<ProcessoView>Sim
idstringSim
numeroProcessostringSim
areastringSim
tribunalstringSim
ufstringSim
classestringSim
graustringSim
valorCausastringSim
dataDistribuicaostringSim
segredoJusticastringSim
statusstringSim
julgamentosarray<JulgamentoView>Sim
tipostringSim
datastringSim
partesarray<ParteProcessoView>Sim
cpfstringSim
cnpjstringSim
tipostringSim
nomestringSim
polostringSim
advogadosarray<string>Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "nomeRazao": "string",
    "documento": "string",
    "nomeFantasia": "string",
    "fundacao": "string",
    "natureza": "string",
    "contagem": "string",
    "processos": [
      {
        "id": "string",
        "numeroProcesso": "string",
        "area": "string",
        "tribunal": "string",
        "uf": "string",
        "classe": "string",
        "grau": "string",
        "valorCausa": "string",
        "dataDistribuicao": "string",
        "segredoJustica": "string",
        "status": "string",
        "julgamentos": [
          {
            "tipo": "string",
            "data": "string"
          }
        ],
        "partes": [
          {
            "cpf": "string",
            "cnpj": "string",
            "tipo": "string",
            "nome": "string",
            "polo": "string",
            "advogados": []
          }
        ]
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/processos?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/processosnome

Processos judiciais pesquisados por nome da parte.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoNome da parte a pesquisar.
tipoquerystringNão—

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewProcessos

Campos da resposta 36 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
nomeRazaostringSim
documentostringSim
nomeFantasiastringSim
fundacaostringSim
naturezastringSim
contagemstringSim
processosarray<ProcessoView>Sim
idstringSim
numeroProcessostringSim
areastringSim
tribunalstringSim
ufstringSim
classestringSim
graustringSim
valorCausastringSim
dataDistribuicaostringSim
segredoJusticastringSim
statusstringSim
julgamentosarray<JulgamentoView>Sim
tipostringSim
datastringSim
partesarray<ParteProcessoView>Sim
cpfstringSim
cnpjstringSim
tipostringSim
nomestringSim
polostringSim
advogadosarray<string>Sim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "nomeRazao": "string",
    "documento": "string",
    "nomeFantasia": "string",
    "fundacao": "string",
    "natureza": "string",
    "contagem": "string",
    "processos": [
      {
        "id": "string",
        "numeroProcesso": "string",
        "area": "string",
        "tribunal": "string",
        "uf": "string",
        "classe": "string",
        "grau": "string",
        "valorCausa": "string",
        "dataDistribuicao": "string",
        "segredoJustica": "string",
        "status": "string",
        "julgamentos": [
          {
            "tipo": "string",
            "data": "string"
          }
        ],
        "partes": [
          {
            "cpf": "string",
            "cnpj": "string",
            "tipo": "string",
            "nome": "string",
            "polo": "string",
            "advogados": []
          }
        ]
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/processosnome?parametro=VALOR&tipo=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/detalhesprocesso

Detalhamento de um processo judicial pelo identificador (id) retornado na consulta de processos.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoIdentificador (id) do processo, retornado em /api/Cadastral/processos.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDetalheProcesso

Campos da resposta 42 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
idstringSim
numeroProcessostringSim
statusstringSim
statusPreditostringSim
graustringSim
juizstringSim
areastringSim
sistemastringSim
segmentostringSim
tribunalstringSim
ufstringSim
orgaoJulgadorstringSim
unidadeOrigemstringSim
dataDistribuicaostringSim
valorCausastringSim
moedastringSim
tutelaAntecipadastringSim
dataProcessamentostringSim
classeobjectNão
nomestringSim
codigoCnjstringSim
assuntosarray<AssuntoView>Sim
titulostringSim
partesarray<ParteDetalheView>Sim
tipostringSim
polostringSim
nomestringSim
cpfstringSim
cnpjstringSim
advogadosstringSim
movimentosarray<MovimentoView>Sim
datastringSim
descricaostringSim
nomeOriginalstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "id": "string",
    "numeroProcesso": "string",
    "status": "string",
    "statusPredito": "string",
    "grau": "string",
    "juiz": "string",
    "area": "string",
    "sistema": "string",
    "segmento": "string",
    "tribunal": "string",
    "uf": "string",
    "orgaoJulgador": "string",
    "unidadeOrigem": "string",
    "dataDistribuicao": "string",
    "valorCausa": "string",
    "moeda": "string",
    "tutelaAntecipada": "string",
    "dataProcessamento": "string",
    "classe": {
      "nome": "string",
      "codigoCnj": "string"
    },
    "assuntos": [
      {
        "titulo": "string"
      }
    ],
    "partes": [
      {
        "tipo": "string",
        "polo": "string",
        "nome": "string",
        "cpf": "string",
        "cnpj": "string",
        "advogados": "string"
      }
    ],
    "movimentos": [
      {
        "data": "string",
        "descricao": "string",
        "nomeOriginal": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/detalhesprocesso?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"
POST/api/Cadastral/detalhesprocessonumero

Detalhamento de um processo judicial pelo número do processo.

Parâmetros

NomeOndeTipoObrigatórioDescrição
parametroquerystringNãoNúmero do processo.

Respostas

200 Success

Schema: ConsultaRespostaOfRetornoViewDetalheProcesso

Campos da resposta 42 campos
CampoTipoNullable
respostaobjectNão
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
retornoobjectNão
idstringSim
numeroProcessostringSim
statusstringSim
statusPreditostringSim
graustringSim
juizstringSim
areastringSim
sistemastringSim
segmentostringSim
tribunalstringSim
ufstringSim
orgaoJulgadorstringSim
unidadeOrigemstringSim
dataDistribuicaostringSim
valorCausastringSim
moedastringSim
tutelaAntecipadastringSim
dataProcessamentostringSim
classeobjectNão
nomestringSim
codigoCnjstringSim
assuntosarray<AssuntoView>Sim
titulostringSim
partesarray<ParteDetalheView>Sim
tipostringSim
polostringSim
nomestringSim
cpfstringSim
cnpjstringSim
advogadosstringSim
movimentosarray<MovimentoView>Sim
datastringSim
descricaostringSim
nomeOriginalstringSim
Exemplo de resposta
{
  "resposta": {
    "idConsulta": "string",
    "dataConsulta": "string",
    "parametro": "string",
    "usuario": "string",
    "tipoConsulta": "string",
    "tempoTotalMs": 0
  },
  "retorno": {
    "id": "string",
    "numeroProcesso": "string",
    "status": "string",
    "statusPredito": "string",
    "grau": "string",
    "juiz": "string",
    "area": "string",
    "sistema": "string",
    "segmento": "string",
    "tribunal": "string",
    "uf": "string",
    "orgaoJulgador": "string",
    "unidadeOrigem": "string",
    "dataDistribuicao": "string",
    "valorCausa": "string",
    "moeda": "string",
    "tutelaAntecipada": "string",
    "dataProcessamento": "string",
    "classe": {
      "nome": "string",
      "codigoCnj": "string"
    },
    "assuntos": [
      {
        "titulo": "string"
      }
    ],
    "partes": [
      {
        "tipo": "string",
        "polo": "string",
        "nome": "string",
        "cpf": "string",
        "cnpj": "string",
        "advogados": "string"
      }
    ],
    "movimentos": [
      {
        "data": "string",
        "descricao": "string",
        "nomeOriginal": "string"
      }
    ]
  }
}
401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X POST "https://api.avaliservice.com.br/api/Cadastral/detalhesprocessonumero?parametro=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Tabelas de apoio

Dados auxiliares para preenchimento das demais chamadas.

GET/api/Municipios

Tabela de municípios — código, nome e UF.

Parâmetros

NomeOndeTipoObrigatórioDescrição
ufquerystringNãoUF de registro do veículo (sigla do estado, ex.: SP).
nomequerystringNão—

Respostas

200 Success
Exemplo de resposta
[
  {
    "codigo": 3500105,
    "nome": "Adamantina",
    "uf": "SP"
  },
  {
    "codigo": 3500204,
    "nome": "Adolfo",
    "uf": "SP"
  },
  {
    "codigo": 3500303,
    "nome": "Aguaí",
    "uf": "SP"
  },
  {
    "codigo": 3500709,
    "nome": "Agudos",
    "uf": "SP"
  },
  {
    "codigo": 3500758,
    "nome": "Alambari",
    "uf": "SP"
  },
  {
    "codigo": 3500808,
    "nome": "Alfredo Marcondes",
    "uf": "SP"
  }
]
400 Bad Request

Schema: ProblemDetails

401 Unauthorized

Schema: ProblemDetails

Exemplo cURL

curl -X GET "https://api.avaliservice.com.br/api/Municipios?uf=VALOR&nome=VALOR" \
  -H "Authorization: Bearer <SEU_TOKEN>"

Modelos de dados

Todos os schemas declarados no contrato OpenAPI, com campos e tipos.

AlertaIndicioView 2 campos
CampoTipoNullable
existeOcorrenciastringSim
descricaoOcorrenciastringSim
AlertaView 3 campos
CampoTipoNullable
severidadestringSim
mensagemstringSim
descricaostringSim
ArquivoCarven 7 campos
CampoTipoNullable
nomestringSim
bytesstringSim
urlstringSim
tamanhointeger (int32)Não
extensaostringSim
mime_typestringSim
hashstringSim
AssuntoView 1 campo
CampoTipoNullable
titulostringSim
BinNacionalView 16 campos
CampoTipoNullable
situacaostringSim
situacaoChassistringSim
tipoVeiculostringSim
especieVeiculostringSim
tipoCarroceriastringSim
potenciaVeiculostringSim
cmtstringSim
pbtstringSim
capacidadeCargastringSim
procedenciastringSim
categoriaVeiculostringSim
quantidadePassageirosstringSim
numeroEixosstringSim
dataEmissaoCrlvstringSim
dataEmissaoUltimoCrvstringSim
restricoesobjectNão
BloqueioLiberadoInfo 17 campos
CampoTipoNullable
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
requisitosLiberacaoarray<string>Sim
orgaoResponsavelLiberacaostringSim
documentoLiberacaostringSim
Cabecalho 6 campos
CampoTipoNullable
idConsultastringSim
dataConsultastringSim
parametrostringSim
usuariostringSim
tipoConsultastringSim
tempoTotalMsinteger (int64)Não
CadastralPfView 7 campos
CampoTipoNullable
documentostringSim
nomestringSim
nascimentostringSim
sexostringSim
nomeMaestringSim
signostringSim
idadestringSim
CadastralPjView 6 campos
CampoTipoNullable
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
nomeFantasiastringSim
codigoNaturezastringSim
descricaoNaturezastringSim
CadastrarComunicadoDados 5 campos
CampoTipoNullable
protocoloInternostringSim
situacaointeger (int32)Não
situacaoNomestringSim
placastringSim
enviadoEmstring (date-time)Sim
CadastrarComunicadoResponse 4 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
dadosobjectNão
CancelarComunicacaoRequest 1 campo
CampoTipoNullable
id_motivo_cancelamentointeger (int32)Não
CancelarComunicadoDados 4 campos
CampoTipoNullable
protocoloInternostringSim
situacaointeger (int32)Não
situacaoNomestringSim
canceladoEmstring (date-time)Sim
CancelarComunicadoResponse 4 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
dadosobjectNão
CheckListLeilaoView 10 campos
CampoTipoNullable
frentestringSim
traseirastringSim
tetostringSim
interiorstringSim
lateralEsquerdastringSim
lateralDireitastringSim
rodasstringSim
queimadostringSim
airBagstringSim
obsstringSim
CheckListRemarketingView 24 campos
CampoTipoNullable
dataInspecaostringSim
motorstringSim
portaMalasstringSim
frentestringSim
frenteDireitastringSim
frenteEsquerdastringSim
portaFrenteDireitastringSim
portaFrenteEsquerdastringSim
portaTraseiraDireitastringSim
portaTraseiraEsquerdastringSim
traseiraDireitastringSim
traseiraEsquerdastringSim
ladoDireitostringSim
ladoEsquerdostringSim
traseirastringSim
cacambastringSim
bancosDianteirosstringSim
bancosTraseirosstringSim
forroTetostringSim
tetostringSim
observacaostringSim
link1stringSim
link2stringSim
garantiastringSim
ClasseView 2 campos
CampoTipoNullable
nomestringSim
codigoCnjstringSim
CnaeView 2 campos
CampoTipoNullable
codigostringSim
descricaostringSim
CompradorDetalhe 5 campos
CampoTipoNullable
tipoPessoastringSim
cpfstringSim
cnpjstringSim
nomestringSim
enderecoobjectNão
ComunicacaoVendaRequest 28 campos
CampoTipoNullable
vendedorTipoPessoastringNão
vendedorCpfstringSim
vendedorCnpjstringSim
vendedorNomestringNão
compradorTipoPessoastringNão
compradorCpfstringSim
compradorCnpjstringSim
compradorNomestringNão
compradorEnderecoCepstringNão
compradorEnderecoLogradourostringNão
compradorEnderecoNumerostringNão
compradorEnderecoBairrostringSim
compradorEnderecoComplementostringSim
compradorEnderecoCidadeinteger (int32)Não
vendaCidadeinteger (int32)Não
vendaDatastringNão
vendaValornumber (double)Não
vendaCompradorSolicitantestringSim
veiculoPlacastringNão
veiculoRenavamstringNão
veiculoAnoFabricacaointeger (int32)Não
veiculoAnoModelointeger (int32)Não
crvNumerostringNão
crvCodigoSegurancastringNão
crvNumeroViainteger (int32)Não
crvDataEmissaostringNão
crvUfEmissaostringNão
arquivosarray<ArquivoCarven>Sim
ComunicadoErro 6 campos
CampoTipoNullable
categoriastringSim
mensagemstringSim
codigostringSim
protocoloInternostringSim
situacaointeger (int32)Sim
situacaoNomestringSim
ComunicadoListItem 7 campos
CampoTipoNullable
protocoloInternostringSim
placastringSim
situacaointeger (int32)Não
situacaoNomestringSim
cobradobooleanNão
criadoEmstring (date-time)Não
enviadoEmstring (date-time)Sim
ConsultaRespostaOfDadosPfView 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfDadosPjView 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewAgregados 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCNH 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCNHPlus 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCRLV 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCRLVRJ2 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCRV 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCSV 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewCSVPrime 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewDadosPlacaPfPj 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewDebitos2 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewDebitosVeiculares 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewDecodificador 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewDetalheProcesso 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewDetalhesComunicado 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewECRLV 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewEstadual 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewFipe 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewFlagCNH 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewGravame 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewGravameHist 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewIndicioSinistro 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewLeilao 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewLeilao2 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewLeilao3 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewNacional 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewNacional2 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewParecerTecnico 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewPfBasic 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewPfMaster 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewPfMid 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewPjBasic 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewPjMaster 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewPjMid 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewProcessos 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewProprietario 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewProtesto 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewRemarketing 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewRenainf 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewRenajud 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewRenajud2 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewRouboFurto 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewRouboFurto2 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewSinistro 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
ConsultaRespostaOfRetornoViewValidacaoSeguros 2 campos
CampoTipoNullable
respostaobjectNão
retornoobjectNão
Controllers_UserLogin 2 campos
CampoTipoNullable
usernamestringSim
passwordstringSim
CrvDetalhe 5 campos
CampoTipoNullable
numerostringSim
codigoSegurancastringSim
numeroViainteger (int32)Sim
dataEmissaostringSim
ufEmissaostringSim
CsvView 2 campos
CampoTipoNullable
quantidadeOcorrenciastringSim
mensagemObservacaostringSim
CursoContainer 1 campo
CampoTipoNullable
cursoobjectNão
CursoDetalhadoInfo 12 campos
CampoTipoNullable
cursoDescricaostringSim
dataIniciostringSim
dataFimstringSim
cnpjEntidadestringSim
cargaHorariastringSim
categoriastringSim
modalidadestringSim
numeroCertificadostringSim
cpfInstrutorstringSim
municipiostringSim
dataValidadestringSim
observacoesstringSim
CursoDetalheInfo 3 campos
CampoTipoNullable
classificacaostringSim
ufstringSim
datastringSim
CursoInfo 5 campos
CampoTipoNullable
tipostringSim
descricaoTipostringSim
classificacaostringSim
ufstringSim
datastringSim
CursoModalidadeInfo 3 campos
CampoTipoNullable
ufstringSim
datastringSim
modalidadestringSim
CursosInfo 8 campos
CampoTipoNullable
tppobjectNão
teobjectNão
tcpobjectNão
tveobjectNão
tciobjectNão
tmfobjectNão
reciclagem_infratorobjectNão
atualizacao_cnhobjectNão
DadoExtra 5 campos
CampoTipoNullable
grupostringSim
chavestringSim
valor1stringSim
valor2stringSim
valor3stringSim
DadosInfratorView 2 campos
CampoTipoNullable
cnhCondutorstringSim
cnhInfratorstringSim
DadosNotificacaoView 22 campos
CampoTipoNullable
cadastroInfracaostringSim
codigoInfracaostringSim
codigoMunicipalEmplacamentostringSim
codigoMunicipalInfracaostringSim
dataEmissaoPenalidadestringSim
dataInfracaostringSim
dataNotificacaoInfracaostringSim
horaInfracaostringSim
limitePermitidostringSim
localInfracaostringSim
marcaModelostringSim
medicaoConsideradastringSim
medicaoRealstringSim
numeroAutoInfracaostringSim
orgaoAutuadorstringSim
ufOrgaoAutuadorstringSim
placastringSim
ufPlacastringSim
ufJurisdicaoVeiculostringSim
tipoAutoInfracaostringSim
valorInfracaostringSim
unidadeMedidastringSim
DadosPagamentoView 4 campos
CampoTipoNullable
dtPagamentostringSim
dtRegistroPgtostringSim
ufPagamentostringSim
valorPagostringSim
DadosPfView 11 campos
CampoTipoNullable
cadastraisobjectNão
moradoresEnderecoarray<MoradorView>Sim
enderecosarray<EnderecoView>Sim
telefonesarray<TelefoneView>Sim
participacaoSocietariaarray<ParticipacaoView>Sim
rendaIbgestringSim
emailsarray<string>Sim
bolsaFamiliastringSim
vinculosarray<VinculoView>Sim
esportistaobjectNão
pepobjectNão
DadosPjView 10 campos
CampoTipoNullable
cadastraisobjectNão
enderecosarray<EnderecoView>Sim
telefonesarray<TelefoneView>Sim
quadroSocietarioarray<SocioView>Sim
cnaearray<CnaeView>Sim
participacaoSocietariaarray<ParticipacaoView>Sim
infoEmpresaobjectNão
filiaisarray<FilialView>Sim
matrizarray<MatrizView>Sim
emailsarray<string>Sim
DadosSuspensaoView 4 campos
CampoTipoNullable
aceiteUfJurisdicaostringSim
dataRegistrostringSim
origemstringSim
tipostringSim
DataInicioCategoriaInfo 5 campos
CampoTipoNullable
astringSim
bstringSim
cstringSim
dstringSim
estringSim
DebitoDetalhe 18 campos
CampoTipoNullable
codigoBarrasstringSim
linhaDigitavelstringSim
valorTotalstringSim
valorSubtotalstringSim
valorTaxasstringSim
valorMultastringSim
valorParcelastringSim
dataVencimentostringSim
dataVencimentoOriginalstringSim
dataReferenciastringSim
identificadorstringSim
descricaostringSim
motivoIndisponibilidadestringSim
guidPagamentostringSim
statusPagamentostringSim
tipointeger (int32)Não
infracaoTransitoobjectNão
dadosExtrasarray<DadoExtra>Sim
Debitos2Detalhe 15 campos
CampoTipoNullable
descricaostringSim
identificadorstringSim
situacaostringSim
valorstringSim
dataVencimentostringSim
codigoFaturastringSim
codigoDebitostringSim
codigoNsustringSim
codigoBarrasstringSim
exigivelinteger (int32)Sim
codigoAutoInfracaostringSim
autoInfracaostringSim
darConcessaobooleanSim
mensagemCdabooleanSim
remetidaProtestobooleanSim
Debitos2Faturamento 2 campos
CampoTipoNullable
ufstringSim
documentostringSim
Debitos2Importacao 2 campos
CampoTipoNullable
numeroDeclaracaostringSim
datastringSim
Debitos2Indicadores 9 campos
CampoTipoNullable
renajudbooleanSim
rouboFurtobooleanSim
leilaobooleanSim
comunicadoVendabooleanSim
rfbbooleanSim
alarmebooleanSim
siniavbooleanSim
recallbooleanSim
pendenciaEmissaobooleanSim
Debitos2Pessoa 3 campos
CampoTipoNullable
nomestringSim
documentostringSim
tipostringSim
Debitos2Veiculo 36 campos
CampoTipoNullable
placastringSim
chassistringSim
renavamstringSim
numeroMotorstringSim
numeroCambiostringSim
situacaostringSim
municipioEmplacamentostringSim
ufstringSim
procedenciastringSim
marcaModelostringSim
corstringSim
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
anoLicenciamentoPagostringSim
tipostringSim
especiestringSim
tipoCarroceriastringSim
numeroCarroceriastringSim
categoriastringSim
cilindradasinteger (int32)Sim
potenciainteger (int32)Sim
combustivelstringSim
pbtstringSim
cmtstringSim
cmcstringSim
capacidadePassageirosinteger (int32)Sim
quantidadeEixosinteger (int32)Sim
dataEmissaoCrvstringSim
dataEmissaoCrlvstringSim
remarcacaoChassistringSim
proprietarioobjectNão
faturadoobjectNão
restricoesarray<string>Sim
indicadoresobjectNão
importacaoobjectNão
faturamentoobjectNão
DetalharComunicadoDados 15 campos
CampoTipoNullable
protocoloInternostringSim
placastringSim
renavamstringSim
vendedorDocumentostringSim
compradorDocumentostringSim
situacaointeger (int32)Não
situacaoNomestringSim
cobradobooleanNão
criadoEmstring (date-time)Não
atualizadoEmstring (date-time)Não
enviadoEmstring (date-time)Sim
canceladoEmstring (date-time)Sim
podeSerAlteradobooleanNão
podeSerCanceladobooleanNão
detalhesobjectNão
DetalharComunicadoResponse 4 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
dadosobjectNão
DetalhesCompletos 5 campos
CampoTipoNullable
vendedorobjectNão
compradorobjectNão
vendaobjectNão
veiculoobjectNão
situacaoobjectNão
DetalhesRenainfView 4 campos
CampoTipoNullable
dadosNotificacaoobjectNão
dadosSuspensaoobjectNão
dadosInfratorobjectNão
dadosPagamentoobjectNão
EnderecoDetalhe 6 campos
CampoTipoNullable
cepstringSim
logradourostringSim
numerostringSim
bairrostringSim
complementostringSim
cidadeinteger (int32)Sim
EnderecoView 8 campos
CampoTipoNullable
tipoLogradourostringSim
logradourostringSim
numerostringSim
complementostringSim
bairrostringSim
cidadestringSim
ufstringSim
cepstringSim
EquipamentoView 2 campos
CampoTipoNullable
descricaostringSim
disponibilidadestringSim
EsportistaView 9 campos
CampoTipoNullable
esportistastringSim
apelidostringSim
modalidadestringSim
funcaostringSim
nomestringSim
equipestringSim
paisstringSim
parentescostringSim
grauVinculostringSim
EventoExclusaoRenajud2 3 campos
CampoTipoNullable
datastringSim
magistradostringSim
orgaostringSim
EventoInclusaoRenajud2 2 campos
CampoTipoNullable
datastringSim
magistradostringSim
ExameInfo 12 campos
CampoTipoNullable
exameDescricaostringSim
dataExamestringSim
dataValidadestringSim
resultadostringSim
categoriaPretendidastringSim
categoriaPermitidastringSim
cpfExaminador1stringSim
cpfExaminador2stringSim
municipioExamestringSim
cnpjEntidadeCredenciadastringSim
observacoesstringSim
restricaostringSim
ExclusaoOcorrenciaRenajud 3 campos
CampoTipoNullable
datastringSim
magistradostringSim
orgaostringSim
FichaTecnicaView 13 campos
CampoTipoNullable
cambiostringSim
direcaostringSim
freioDianteirostringSim
freioTraseirostringSim
motorDescricaostringSim
quantidadePassageirosstringSim
quantidadePortasstringSim
suspensaoDianteirastringSim
suspensaoTraseirastringSim
tipoTracaostringSim
medidasobjectNão
medicaoCombustivelarray<MedicaoCombustivelView>Sim
equipamentosarray<EquipamentoView>Sim
FilialView 6 campos
CampoTipoNullable
quantidadestringSim
ativastringSim
inaptastringSim
suspensastringSim
baixadastringSim
nulastringSim
FipeView 10 campos
CampoTipoNullable
statusstringSim
chassistringSim
codigoFipestringSim
fabricantestringSim
modelostringSim
anoModelostringSim
combustivelstringSim
precoFipestringSim
precoMediostringSim
vigenciastringSim
HabilitacaoEstrangeiraInfo 4 campos
CampoTipoNullable
registrostringSim
pais_origemstringSim
identificacaostringSim
validadestringSim
Historico12MesesView 3 campos
CampoTipoNullable
idinteger (int32)Não
anoMesstringSim
valorstringSim
InfoEmpresaView 5 campos
CampoTipoNullable
numeroFuncionariosstringSim
portestringSim
faturamentostringSim
filiaisstringSim
capitalSocialstringSim
InfracaoTransitoDetalhe 7 campos
CampoTipoNullable
codigostringSim
artigostringSim
descricaostringSim
pontosinteger (int32)Não
gravidadestringSim
responsavelstringSim
valorBasestringSim
JulgamentoView 2 campos
CampoTipoNullable
tipostringSim
datastringSim
Leilao3ItemView 23 campos
CampoTipoNullable
nsuVeiculostringSim
idLeilaostringSim
lotestringSim
marcastringSim
modelostringSim
anoModelostringSim
anoFabricacaostringSim
chassistringSim
renavamstringSim
corstringSim
combustivelstringSim
categoriaVeiculostringSim
condicaoVeiculostringSim
situacaoChassistringSim
nrMotorstringSim
nrCambiostringSim
nrCarroceriastringSim
nrEixoTraseirostringSim
quantidadeEixosstringSim
patiostringSim
leiloeirostringSim
dataLeilaostringSim
comitentestringSim
LeilaoItemView 19 campos
CampoTipoNullable
lotestringSim
marcastringSim
modelostringSim
anoModelostringSim
anoFabricacaostringSim
chassistringSim
renavamstringSim
corstringSim
combustivelstringSim
dataLeilaostringSim
leiloeirostringSim
comitentestringSim
patiostringSim
categoriaVeiculostringSim
condicaoVeiculostringSim
nrMotorstringSim
nrCambiostringSim
quantidadeDeEixosstringSim
segmentoComitentestringSim
ListarComunicadosResponse 5 campos
CampoTipoNullable
sucessobooleanNão
mensagemstringSim
erroobjectNão
totalinteger (int32)Não
dadosarray<ComunicadoListItem>Sim
LoginResponse 1 campo
CampoTipoNullable
tokenstringSim
MatrizView 3 campos
CampoTipoNullable
cnpjstringSim
condicaostringSim
matrizstringSim
MedicaoCombustivelView 8 campos
CampoTipoNullable
combustivelstringSim
potenciastringSim
cilindradasstringSim
torquestringSim
velocidadeMaximastringSim
tempoZeroACemstringSim
consumoCidadestringSim
consumoEstradastringSim
MedidasView 7 campos
CampoTipoNullable
alturastringSim
largurastringSim
comprimentostringSim
entreEixosstringSim
pesostringSim
portaMalasstringSim
tanqueCombustivelstringSim
Models_RetornoViews_RetornoViewCNHPlus_BloqueioInfo 14 campos
CampoTipoNullable
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
Models_RetornoViews_RetornoViewCNH_BloqueioInfo 14 campos
CampoTipoNullable
mensagemstringSim
dataInicioPenalidadestringSim
dataTerminoPenalidadestringSim
descricaostringSim
descricaoMotivostringSim
documentoGeradorstringSim
decisaostringSim
prazostringSim
descricaoPrazostringSim
prazoTotalstringSim
descricaoPrazoTotalstringSim
recolhimentoCNHstringSim
ufDetranstringSim
orgaoResponsavelstringSim
Models_RetornoViews_VeiculoRegistro 10 campos
CampoTipoNullable
modelostringSim
placastringSim
renavamstringSim
chassistringSim
estadostringSim
corstringSim
anoFabricacaostringSim
motorstringSim
anoModelostringSim
especiestringSim
MoradorView 2 campos
CampoTipoNullable
cpfstringSim
nomestringSim
MovimentoView 3 campos
CampoTipoNullable
datastringSim
descricaostringSim
nomeOriginalstringSim
MultaInfo 3 campos
CampoTipoNullable
codigostringSim
descricaostringSim
quantidadestringSim
MunicipioDto 3 campos
CampoTipoNullable
codigointeger (int32)Não
nomestringSim
ufstringSim
Ocorrencia 16 campos
CampoTipoNullable
declaracaostringSim
boletimstringSim
codigoOrgaoSegurancastringSim
ocorrenciastringSim
municipiostringSim
uFstringSim
dataOcorrenciastringSim
placastringSim
chassistringSim
marcaModelostringSim
corstringSim
informantestringSim
documentostringSim
numeroDocumentostringSim
ramalstringSim
telefonestringSim
OcorrenciaComunicadoView 7 campos
CampoTipoNullable
placastringSim
renavamstringSim
documentoProprietariostringSim
dataVendastringSim
dataRegistroVendastringSim
documentoCompradorstringSim
nomeCompradorstringSim
OcorrenciaGravameView 17 campos
CampoTipoNullable
codigoStatusstringSim
statusGravamestringSim
statusVeiculostringSim
dataAtualizacaoStatusstringSim
renavamstringSim
ufPlacastringSim
placastringSim
ufLicenciamentostringSim
chassistringSim
docFinanciadostringSim
nomeFinanciadostringSim
docAgentestringSim
nomeAgentestringSim
numeroGravamestringSim
numeroContratostringSim
dataInclusaoGravamestringSim
dataContratostringSim
OcorrenciaRenainfView 7 campos
CampoTipoNullable
descricaostringSim
autoInfracaostringSim
dataInfracaostringSim
exigibilidadestringSim
infracaostringSim
orgaoAtuadorstringSim
detalhesobjectNão
OcorrenciaRenajud 10 campos
CampoTipoNullable
constaRestricaostringSim
chassistringSim
placastringSim
municipioOrgaostringSim
tipoRestricaostringSim
nomeTribunalstringSim
nomeOrgaoJudicialstringSim
numeroProcessostringSim
dataInclusaostringSim
exclusaoobjectNão
OcorrenciaRenajud2 8 campos
CampoTipoNullable
idstringSim
statusstringSim
tipoRestricaostringSim
numeroProcessostringSim
tribunalobjectNão
orgaoJulgadorobjectNão
inclusaoobjectNão
exclusaoobjectNão
OrgaoJulgadorRenajud2 4 campos
CampoTipoNullable
idinteger (int64)Sim
nomestringSim
municipiostringSim
ufstringSim
ParteDetalheView 6 campos
CampoTipoNullable
tipostringSim
polostringSim
nomestringSim
cpfstringSim
cnpjstringSim
advogadosstringSim
ParteProcessoView 6 campos
CampoTipoNullable
cpfstringSim
cnpjstringSim
tipostringSim
nomestringSim
polostringSim
advogadosarray<string>Sim
ParticipacaoView 6 campos
CampoTipoNullable
cnpjstringSim
razaoSocialstringSim
documentostringSim
percentualstringSim
datastringSim
qualificacaostringSim
PepView 10 campos
CampoTipoNullable
pepstringSim
nomestringSim
funcaostringSim
nivelstringSim
orgaostringSim
dataIniciostringSim
dataFimstringSim
dataFimCarenciastringSim
parentescostringSim
grauVinculostringSim
PessoaDetalhe 4 campos
CampoTipoNullable
tipoPessoastringSim
cpfstringSim
cnpjstringSim
nomestringSim
PrecificadorIHistFipeView 8 campos
CampoTipoNullable
dsCodigostringSim
nuValornumber (double)Não
dsMarcastringSim
dsModelostringSim
dsCombustivelstringSim
mesRefFipeZeroKMstringSim
nuValorZeroKMnumber (double)Não
historio12Mesesarray<Historico12MesesView>Sim
PrecificadorIIView 6 campos
CampoTipoNullable
dsCodigostringSim
dsMarcastringSim
dsModelostringSim
dsVersaostringSim
dsCombustivelstringSim
dsNuValorstringSim
PrecificadorView 8 campos
CampoTipoNullable
fabricanteModelostringSim
anoModelostringSim
combustivelstringSim
informantestringSim
codigostringSim
vigenciastringSim
precostringSim
precoMediostringSim
ProblemDetails 5 campos
CampoTipoNullable
typestringSim
titlestringSim
statusinteger (int32)Sim
detailstringSim
instancestringSim
ProcessoView 13 campos
CampoTipoNullable
idstringSim
numeroProcessostringSim
areastringSim
tribunalstringSim
ufstringSim
classestringSim
graustringSim
valorCausastringSim
dataDistribuicaostringSim
segredoJusticastringSim
statusstringSim
julgamentosarray<JulgamentoView>Sim
partesarray<ParteProcessoView>Sim
ProprietarioRenajud2 3 campos
CampoTipoNullable
nomestringSim
documentostringSim
enderecostringSim
ProtestoDetalhe 10 campos
CampoTipoNullable
ufstringSim
municipiostringSim
cartoriostringSim
telefoneCartoriostringSim
dataProtestostringSim
vencimentostringSim
valorProtestadostringSim
valorTitulostringSim
apresentantestringSim
cedentestringSim
RaAcaoValor 2 campos
CampoTipoNullable
datastringSim
valornumber (double)Não
RaAdministradorCompleto 8 campos
CampoTipoNullable
documentostringSim
nomestringSim
cargostringSim
dataEntradastringSim
mandatostringSim
nacionalidadestringSim
estadoCivilstringSim
possuiAnotacaoNegativabooleanNão
RaBlocoAcoes 2 campos
CampoTipoNullable
registrosarray<RaAcaoValor>Sim
resumoobjectNão
RaCadastroPf 7 campos
CampoTipoNullable
cpfstringSim
nomestringSim
nomeMaestringSim
sexostringSim
dataNascimentostringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
RaCadastroPfMaster 11 campos
CampoTipoNullable
cpfstringSim
nomestringSim
nomeMaestringSim
sexostringSim
dataNascimentostringSim
idadestringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
municipioUfstringSim
enderecosarray<RaEnderecoPf>Sim
telefonesarray<RaTelefonePf>Sim
RaCadastroPjBasic 5 campos
CampoTipoNullable
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
situacaoCadastralstringSim
enderecostringSim
RaCadastroPjMaster 26 campos
CampoTipoNullable
cnpjstringSim
dataAtualizacaostringSim
situacaoCadastralstringSim
razaoSocialstringSim
nomeFantasiastringSim
dataFundacaostringSim
idadeEmpresastringSim
municipioUfstringSim
ramoAtividadestringSim
tipoSociedadestringSim
numeroFuncionariosstringSim
quantidadeFiliaisinteger (int32)Sim
opcaoTributariastringSim
enderecostringSim
sitestringSim
telefonestringSim
cnaestringSim
atividadeEconomicastringSim
inscricaoEstadualstringSim
nirestringSim
numeroRegistrostringSim
dataRegistrostringSim
percentualImportacaoComprasstringSim
percentualExportacaoVendasstringSim
codigoAtividadestringSim
empresaAntecessorastringSim
RaCadastroPjMid 6 campos
CampoTipoNullable
cnpjstringSim
razaoSocialstringSim
dataFundacaostringSim
situacaoCadastralstringSim
dataAtualizacaoSituacaostringSim
enderecostringSim
RaCategoriaDataValor 2 campos
CampoTipoNullable
registrosarray<RaDataValor>Sim
resumoobjectNão
RaCategoriaDividaPf 2 campos
CampoTipoNullable
registrosarray<RaDividaPf>Sim
resumoobjectNão
RaCategoriaDividaPj 2 campos
CampoTipoNullable
registrosarray<RaDividaPj>Sim
resumoobjectNão
RaCategoriaProtesto 2 campos
CampoTipoNullable
registrosarray<RaProtesto>Sim
resumoobjectNão
RaCategoriaVencidaPf 2 campos
CampoTipoNullable
registrosarray<RaDividaVencidaPf>Sim
resumoobjectNão
RaChequeSustado 12 campos
CampoTipoNullable
titularstringSim
bancostringSim
codigoBancointeger (int32)Sim
agenciainteger (int32)Sim
contastringSim
chequeInicialstringSim
chequeFinalstringSim
valorChequenumber (double)Não
motivostringSim
dataHoraInclusaostringSim
mensagemstringSim
quantidadeChequesinteger (int32)Sim
RaChequesSustados 1 campo
CampoTipoNullable
registrosarray<RaChequeSustado>Sim
RaConsultaPf 3 campos
CampoTipoNullable
datastringSim
quantidadeNoDiainteger (int32)Sim
segmentostringSim
RaConsultaPj 4 campos
CampoTipoNullable
datastringSim
razaoSocialConsultantestringSim
documentoConsultantestringSim
quantidadeNoDiainteger (int32)Sim
RaConsultasPf 3 campos
CampoTipoNullable
registrosarray<RaConsultaPf>Sim
resumoobjectNão
historicoMensalarray<RaHistoricoMensal>Sim
RaConsultasPj 3 campos
CampoTipoNullable
registrosarray<RaConsultaPj>Sim
resumoobjectNão
historicoMensalarray<RaHistoricoMensal>Sim
RaDataValor 2 campos
CampoTipoNullable
datastringSim
valornumber (double)Não
RaDividaPf 8 campos
CampoTipoNullable
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
comarcastringSim
avalistabooleanNão
codigoOcorrenciastringSim
RaDividaPj 7 campos
CampoTipoNullable
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
avalistabooleanNão
codigoOcorrenciastringSim
RaDividaVencidaPf 9 campos
CampoTipoNullable
datastringSim
valornumber (double)Não
modalidadestringSim
numeroContratostringSim
credorstringSim
cidadestringSim
ufstringSim
avalistabooleanNão
codigoOcorrenciastringSim
RaDocumentoRoubado 2 campos
CampoTipoNullable
datastringSim
descricaostringSim
RaDocumentosRoubados 2 campos
CampoTipoNullable
registrosarray<RaDocumentoRoubado>Sim
resumoobjectNão
RaEnderecoPf 3 campos
CampoTipoNullable
enderecostringSim
prioridadestringSim
dataAtualizacaostringSim
RaHistoricoMensal 2 campos
CampoTipoNullable
mesReferenciastringSim
ocorrenciasinteger (int32)Não
RaInformacoesComplementares 13 campos
CampoTipoNullable
orgaoEmissorstringSim
ufEmissaostringSim
dataEmissaostringSim
cidadeNascimentostringSim
ufNascimentostringSim
estadoCivilstringSim
dependentesstringSim
escolaridadestringSim
ocupacaostringSim
profissaostringSim
cargostringSim
nomeEmpresastringSim
cnpjEmpresastringSim
RaListaMembros 1 campo
CampoTipoNullable
registrosarray<RaMembroSimples>Sim
RaMembroSimples 6 campos
CampoTipoNullable
documentostringSim
nomestringSim
situacaostringSim
percentualCapitalnumber (double)Sim
cargostringSim
possuiAnotacaoNegativabooleanNão
RaParticipacao 9 campos
CampoTipoNullable
cnpjstringSim
razaoSocialstringSim
percentualCapitalnumber (double)Não
situacaoEmpresastringSim
ufEmpresastringSim
dataSituacaoEmpresastringSim
dataAtualizacaostringSim
dataInicioParticipacaostringSim
possuiAnotacaoNegativabooleanNão
RaParticipacoes 2 campos
CampoTipoNullable
registrosarray<RaParticipacao>Sim
resumoobjectNão
RaPendenciasPf 7 campos
CampoTipoNullable
resumoGeralobjectNão
dividasComerciaisobjectNão
dividasFinanceirasobjectNão
dividasVencidasobjectNão
dividasProtestadasobjectNão
chequeSemFundoobjectNão
cobrancaobjectNão
RaPendenciasPj 7 campos
CampoTipoNullable
resumoGeralobjectNão
dividasComerciaisobjectNão
dividasFinanceirasobjectNão
dividasVencidasobjectNão
dividasProtestadasobjectNão
chequeSemFundoobjectNão
cobrancaobjectNão
RaProtesto 6 campos
CampoTipoNullable
datastringSim
valornumber (double)Não
cartoriostringSim
cidadestringSim
ufstringSim
codigoOcorrenciastringSim
RaQuadroSocietarioCompleto 9 campos
CampoTipoNullable
capitalSocialnumber (double)Não
capitalRealizadonumber (double)Não
dataAtualizacaostringSim
paisOrigemstringSim
tipoControlestringSim
tipoCapitalstringSim
resumoAnotacoesobjectNão
sociosarray<RaSocioCompleto>Sim
administradoresarray<RaAdministradorCompleto>Sim
RaResumoAnotacoes 2 campos
CampoTipoNullable
sociosinteger (int32)Não
administradoresinteger (int32)Não
RaResumoConsultaPf 3 campos
CampoTipoNullable
quantidadeinteger (int32)Não
consultasMesAtualinteger (int32)Não
consultasUltimos4Mesesinteger (int32)Não
RaResumoConsultaPj 3 campos
CampoTipoNullable
quantidadeinteger (int32)Não
consultasMesAtualinteger (int32)Não
consultasUltimos13Mesesinteger (int32)Não
RaResumoGeral 2 campos
CampoTipoNullable
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
RaResumoPendencia 4 campos
CampoTipoNullable
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
primeiraOcorrenciastringSim
ultimaOcorrenciastringSim
RaResumoQtd 1 campo
CampoTipoNullable
quantidadeinteger (int32)Não
RaResumoValor 2 campos
CampoTipoNullable
quantidadeinteger (int32)Não
valorTotalnumber (double)Não
RaScorePf 3 campos
CampoTipoNullable
pontuacaostringSim
modelostringSim
chancePagamentostringSim
RaScorePjMaster 6 campos
CampoTipoNullable
pontuacaostringSim
modelostringSim
classificacaoRiscostringSim
probabilidadeInadimplenciastringSim
riscoCreditostringSim
praticaMercadoRecomendadastringSim
RaScorePjMid 4 campos
CampoTipoNullable
pontuacaostringSim
modelostringSim
probabilidadeInadimplenciastringSim
faturamentoDisponivelbooleanSim
RaSocioCompleto 7 campos
CampoTipoNullable
documentostringSim
nomestringSim
percentualCapitalnumber (double)Não
percentualCapitalVotantenumber (double)Não
dataEntradastringSim
nacionalidadestringSim
possuiAnotacaoNegativabooleanNão
RaTelefonePf 4 campos
CampoTipoNullable
telefonestringSim
prioridadestringSim
tipostringSim
dataAtualizacaostringSim
RecallItem 4 campos
CampoTipoNullable
nomeRecallstringSim
descricaoRecallstringSim
dataRegistrostringSim
dataRegistroFormatadastringSim
RecallOcorrenciaView 4 campos
CampoTipoNullable
codigoRecallstringSim
descricaoRecallstringSim
dataIniciostringSim
dataFimstringSim
RecallView 2 campos
CampoTipoNullable
quantidadeOcorrenciasstringSim
ocorrenciasarray<RecallOcorrenciaView>Sim
RegistroLeilaoView 10 campos
CampoTipoNullable
leiloeirostringSim
comitentestringSim
lotestringSim
dataLeilaostringSim
condicoesVeiculostringSim
situacaoChassistringSim
condicoesMotorstringSim
condicoesCambiostringSim
condicoesMecanicastringSim
observacaostringSim
RegistroRemarketingView 10 campos
CampoTipoNullable
organizadorstringSim
vendedorstringSim
itemstringSim
dataEventostringSim
condicoesVeiculostringSim
situacaoChassistringSim
condicoesMotorstringSim
condicoesCambiostringSim
condicoesMecanicastringSim
observacaostringSim
RenainfView 1 campo
CampoTipoNullable
qtdOcorrenciasstringSim
RenajudView 2 campos
CampoTipoNullable
quantidadeOcorrenciasstringSim
msgAlertastringSim
RestricoesView 5 campos
CampoTipoNullable
existeRestricaoRouboFurtostringSim
veiculoBaixadostringSim
existeRestricaoRenajudstringSim
existeRestricaoGeralstringSim
mensagensRestricoesarray<string>Sim
RetornoViewAgregados 19 campos
CampoTipoNullable
placastringSim
ufPlacastringSim
chassistringSim
marcaModelostringSim
tipostringSim
combustivelstringSim
corstringSim
renavamstringSim
nrMotorstringSim
nrCambiostringSim
situacaoVeiculostringSim
municipiostringSim
especiestringSim
procedenciaVeiculostringSim
capacidadeDePassageirosstringSim
cilindradastringSim
capacidadeCargastringSim
ufDestFaturadostringSim
dataUltimaAtualizacaostringSim
RetornoViewCNH 38 campos
CampoTipoNullable
numeroRegistrostringSim
numeroFormularioRenachstringSim
numeroFormularioCnhstringSim
categoriaAtualstringSim
categoriaAutorizadastringSim
dataValidadestringSim
dataPrimeiraHabilitacaostringSim
dataUltimaEmissaostringSim
dataCadastramentostringSim
ufDominiostringSim
observacaostringSim
permissionadostringSim
situacaostringSim
situacaoAnteriorstringSim
cpfstringSim
nomestringSim
emailstringSim
dataNascimentostringSim
tipoDocumentostringSim
documentostringSim
orgaoExpedidorstringSim
ufOrgaoExpedidorstringSim
nacionalidadestringSim
localNascimentostringSim
sexostringSim
nomeMaestringSim
nomePaistringSim
logradourostringSim
numerostringSim
bairrostringSim
municipiostringSim
ufstringSim
cepstringSim
complementostringSim
bloqueiosarray<Models_RetornoViews_RetornoViewCNH_BloqueioInfo>Sim
toxicologicoDataExamestringSim
toxicologicoDataValidadestringSim
cursosarray<CursoContainer>Sim
RetornoViewCNHPlus 54 campos
CampoTipoNullable
numeroRegistrostringSim
numeroFormularioRenachstringSim
numeroFormularioCnhstringSim
categoriaAtualstringSim
categoriaAutorizadastringSim
dataValidadestringSim
dataPrimeiraHabilitacaostringSim
dataUltimaEmissaostringSim
dataCadastramentostringSim
ufDominiostringSim
observacaostringSim
permissionadostringSim
situacaostringSim
situacaoAnteriorstringSim
cpfstringSim
nomestringSim
dataNascimentostringSim
tipoDocumentostringSim
documentostringSim
orgaoExpedidorstringSim
ufOrgaoExpedidorstringSim
nacionalidadestringSim
localNascimentostringSim
sexostringSim
nomeMaestringSim
nomePaistringSim
enderecostringSim
cancelamentostringSim
categoriaRebaixadastringSim
exerceAtividadeRemuneradastringSim
habilitacaoEstrangeiraobjectNão
multasarray<MultaInfo>Sim
numeroListaImpedimentostringSim
numeroPgustringSim
quantidadeImpedimentosstringSim
requerimentosarray<string>Sim
restricoesMedicasstringSim
ufHabilitacaoAtualstringSim
ufPrimeiraHabilitacaostringSim
ufSolicitanteTransferenciastringSim
bloqueiosarray<Models_RetornoViews_RetornoViewCNHPlus_BloqueioInfo>Sim
toxicologicoDataExamestringSim
toxicologicoDataValidadestringSim
cursosobjectNão
fotostringSim
nomeSocialstringSim
telefonestringSim
emailstringSim
filiacaoAfetivaMaestringSim
filiacaoAfetivaPaistringSim
dataInicioCategoriaobjectNão
cursoDetalhadoarray<CursoDetalhadoInfo>Sim
examesarray<ExameInfo>Sim
bloqueiosLiberadosarray<BloqueioLiberadoInfo>Sim
RetornoViewCRLV 5 campos
CampoTipoNullable
ufstringSim
placastringSim
statusstringSim
crlvBase64stringSim
mensagemErrostringSim
RetornoViewCRLVRJ2 10 campos
CampoTipoNullable
placastringSim
ufstringSim
municipiostringSim
chassistringSim
renavamstringSim
documentostringSim
marcastringSim
anoFabricacaostringSim
anoModelostringSim
base64stringSim
RetornoViewCRV 3 campos
CampoTipoNullable
placastringSim
crvBase64stringSim
mensagemErrostringSim
RetornoViewCSV 97 campos
CampoTipoNullable
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
cmcnumber (double)Sim
cmtnumber (double)Sim
tipoCarroceriaCodigostringSim
tipoCarroceriaDescricaostringSim
categoriaDescricaostringSim
chassiSeriestringSim
cilindradasinteger (int32)Sim
combustivelCodigostringSim
combustivelDescricaostringSim
corCodigostringSim
corDescricaostringSim
especieDescricaostringSim
indicadorAlarmebooleanSim
indicadorRouboFurtobooleanSim
lotacaointeger (int32)Sim
marcaModeloCodigostringSim
marcaModeloDescricaostringSim
municipioEmplacamentoCodigostringSim
municipioEmplacamentoDescricaostringSim
qtdEixosinteger (int32)Sim
pbtnumber (double)Sim
potenciainteger (int32)Sim
numeroIdentificacaoProprietariostringSim
situacaostringSim
tipoVeiculoCodigostringSim
tipoVeiculoDescricaostringSim
ufJurisdicaostringSim
indicadorComunicacaoVendabooleanSim
indicadorLeilaobooleanSim
indicadorMultaRenainfbooleanSim
indicadorPendenciaEmissaobooleanSim
indicadorRecall1booleanSim
indicadorRecall2booleanSim
indicadorRecall3booleanSim
indicadorRecallMontadorabooleanSim
restricao1CodigostringSim
restricao1DescricaostringSim
restricao2CodigostringSim
restricao2DescricaostringSim
restricao3CodigostringSim
restricao3DescricaostringSim
restricao4CodigostringSim
restricao4DescricaostringSim
indicadorRestricaoRenajudbooleanSim
restricaoRfbIndicadorstringSim
restricaoRfbDescricaostringSim
procedenciastringSim
indicadorOstentaPIVbooleanSim
tipoArrendatarioCodigostringSim
tipoArrendatarioDescricaostringSim
numeroCarroceriastringSim
remarcacaoChassiCodigostringSim
remarcacaoChassiDescricaostringSim
dataEmissaoCrvstringSim
dataUltimaAtualizacaostringSim
orgaoRfbCodigostringSim
orgaoRfbDescricaostringSim
numeroEixoAuxiliarstringSim
numeroEixoTraseirostringSim
naturezaFaturadostringSim
ufFaturadostringSim
naturezaImportadorstringSim
descricaoDocImportadorstringSim
paisTransferenciaCodigostringSim
paisTransferenciaDescricaostringSim
docProprietarioIndicadoTipostringSim
docProprietarioIndicadoDescricaostringSim
tipoProprietarioCodigostringSim
tipoProprietarioDescricaostringSim
nomeArrendatariostringSim
numeroIdentificacaoArrendatariostringSim
numeroCambiostringSim
chassistringSim
numeroDeclaracaoImportacaostringSim
numeroIdFaturamentostringSim
numeroIdImportadorstringSim
numeroMotorstringSim
placastringSim
possuidorNomestringSim
possuidorNumeroDocumentostringSim
possuidorOrigemstringSim
numeroDocProprietarioIndicadostringSim
nomeProprietariostringSim
registroAduaneirostringSim
codigoRenavamstringSim
usuarioEhPossuidorbooleanSim
usuarioEhPrincipalCondutorbooleanSim
usuarioFoiPrincipalCondutorbooleanSim
listaCsvarray<string>Sim
permiteBaixarCrvlDigitalbooleanSim
recallQuantidadeinteger (int32)Sim
recallQuantidadeRealinteger (int32)Sim
recallsarray<RecallItem>Sim
laudosarray<string>Sim
pdfBase64stringSim
RetornoViewCSVPrime 25 campos
CampoTipoNullable
chassistringSim
placastringSim
renavamstringSim
marcaModelostringSim
corVeiculostringSim
anoModelostringSim
anoFabricacaostringSim
combustivelstringSim
motorstringSim
ufstringSim
municipiostringSim
dataAtualizacaostringSim
crlvstringSim
proprietarioNomestringSim
proprietarioDocumentostringSim
binNacionalobjectNão
precificadorarray<PrecificadorView>Sim
quantidadeAlertasstringSim
alertasarray<AlertaView>Sim
renajudobjectNão
recallobjectNão
csvobjectNão
renainfobjectNão
fichaTecnicaobjectNão
alertaIndicioobjectNão
RetornoViewDadosPlacaPfPj 3 campos
CampoTipoNullable
veiculoobjectNão
dadosPfobjectNão
dadosPjobjectNão
RetornoViewDebitos2 4 campos
CampoTipoNullable
veiculoobjectNão
debitosarray<Debitos2Detalhe>Sim
valorTotalDebitosstringSim
quantidadeDebitosinteger (int32)Não
RetornoViewDebitosVeiculares 3 campos
CampoTipoNullable
debitosarray<DebitoDetalhe>Sim
valorTotalDebitosstringSim
quantidadeDebitosinteger (int32)Não
RetornoViewDecodificador 17 campos
CampoTipoNullable
dsChassistringSim
dsChassiTratadostringSim
dsOrigemstringSim
dsRegiaostringSim
dsPaisstringSim
dsCategoriastringSim
dsMarcastringSim
dsModelostringSim
dsVersaostringSim
nuAnoModelointeger (int32)Sim
dsTipoCarroceriastringSim
dsMotorstringSim
nuCdCombustivelinteger (int32)Sim
dsCombustivelstringSim
dsLocalFabricacaostringSim
precificadorIHistFipearray<PrecificadorIHistFipeView>Sim
precificadorIIarray<PrecificadorIIView>Sim
RetornoViewDetalheProcesso 22 campos
CampoTipoNullable
idstringSim
numeroProcessostringSim
statusstringSim
statusPreditostringSim
graustringSim
juizstringSim
areastringSim
sistemastringSim
segmentostringSim
tribunalstringSim
ufstringSim
orgaoJulgadorstringSim
unidadeOrigemstringSim
dataDistribuicaostringSim
valorCausastringSim
moedastringSim
tutelaAntecipadastringSim
dataProcessamentostringSim
classeobjectNão
assuntosarray<AssuntoView>Sim
partesarray<ParteDetalheView>Sim
movimentosarray<MovimentoView>Sim
RetornoViewDetalhesComunicado 15 campos
CampoTipoNullable
mensagemstringSim
existeComunicadoVendastringSim
quantidadeOcorrenciasstringSim
placastringSim
chassistringSim
renavamstringSim
marcaModelostringSim
corVeiculostringSim
anoModelostringSim
anoFabricacaostringSim
ufstringSim
municipiostringSim
proprietarioDocumentostringSim
proprietarioNomestringSim
ocorrenciasarray<OcorrenciaComunicadoView>Sim
RetornoViewECRLV 6 campos
CampoTipoNullable
bancostringSim
situacaostringSim
placastringSim
renavamstringSim
documentostringSim
ecrlvBase64stringSim
RetornoViewEstadual 50 campos
CampoTipoNullable
situacaoVeiculostringSim
placastringSim
municipiostringSim
ufstringSim
renavamstringSim
cpfCnpjProprietariostringSim
tipoDocumentoProprietariostringSim
pronomestringSim
propAntestringSim
licDatastringSim
dataEmissaoCrvstringSim
chassistringSim
tipoDocumentoFaturadostringSim
cpfCnpjFaturadostringSim
ufFaturadostringSim
tipoRemarcacaoChassistringSim
marcaModeloCompletostringSim
marcastringSim
modelostringSim
veiculoAnoFabricacaostringSim
veiculoAnoModelostringSim
tipostringSim
carroceriastringSim
corstringSim
especiestringSim
categoriaVeiculostringSim
combustivelstringSim
potenciastringSim
cilindradastringSim
capacidadeCargastringSim
veiculoProcedenciastringSim
capacidadePassageirosstringSim
comunicadoVendastringSim
numeroCambiostringSim
motorstringSim
cmtstringSim
pbtstringSim
eixosstringSim
existeDebitoDeIpvastringSim
existeDebitoMultastringSim
debitoIpvastringSim
existeDebitoLicenciamentostringSim
existeDebitoLicenciamentoValorstringSim
valorTotalDebitoMultastringSim
existeDebitoDpvatstringSim
dpvatstringSim
outrasRestricoesUmstringSim
outrasRestricoesDoisstringSim
outrasRestricoesTresstringSim
outrasRestricoesQuatrostringSim
RetornoViewFipe 1 campo
CampoTipoNullable
registrosarray<FipeView>Sim
RetornoViewFlagCNH 3 campos
CampoTipoNullable
codigostringSim
possuiCNHbooleanNão
possuiCNHTextostringSim
RetornoViewGravame 43 campos
CampoTipoNullable
temGravamebooleanNão
mensagemStatusstringSim
chassiSngstringSim
chaveRetornostringSim
placastringSim
ufPlacastringSim
anoFabricacaostringSim
anoModelostringSim
renavamstringSim
documentoProprietariostringSim
nomeFinanciadostringSim
numeroContratostringSim
documentoFinanceirastringSim
financeiraNomestringSim
codigoFinanceirastringSim
dataGravamestringSim
dataGravameVigenciastringSim
ufGravamestringSim
statusDoVeiculostringSim
descricaoStatusstringSim
marcaModelostringSim
tipostringSim
cambiostringSim
combustivelstringSim
corstringSim
especiestringSim
motorstringSim
potenciastringSim
situacaoChassistringSim
capacidadeCilindradastringSim
quantidadePassageirosstringSim
procedenciastringSim
tipoCarroceriastringSim
tipoMontagemstringSim
capacidadeCargastringSim
cmtstringSim
pbtstringSim
eixoQuantidadestringSim
eixoAuxiliarstringSim
eixoTraseirostringSim
docImportadorstringSim
dataAtualizacaostringSim
dataLimiteRestricaoTributariastringSim
RetornoViewGravameHist 13 campos
CampoTipoNullable
chassistringSim
placastringSim
ufPlacastringSim
renavamstringSim
marcaModelostringSim
corstringSim
anoModelostringSim
anoFabricacaostringSim
tipoVeiculostringSim
combustivelstringSim
procedenciastringSim
quantidadeGravamesstringSim
gravamesarray<OcorrenciaGravameView>Sim
RetornoViewIndicioSinistro 2 campos
CampoTipoNullable
indicadorIndiciobooleanSim
mensagemSinistrostringSim
RetornoViewLeilao 28 campos
CampoTipoNullable
existeRegistrobooleanNão
placastringSim
chassistringSim
descricaostringSim
modelostringSim
situacaoChassistringSim
anoFabricacaostringSim
anoModelostringSim
combustivelstringSim
corstringSim
renavamstringSim
segmentostringSim
subSegmentostringSim
scorestringSim
aceitaVeiculostringSim
percentualSobreRefstringSim
exigenciaVistoriaEspecialstringSim
scorePontuacaostringSim
motorstringSim
numeroCaixaCambiostringSim
numeroCarroceriastringSim
numeroEixoTraseiroDiferencialstringSim
quantidadeDeEixosstringSim
registrosLeilaoarray<RegistroLeilaoView>Sim
checkListobjectNão
quantidadePesquisasUltimosMesesstringSim
historicoPesquisastringSim
controleHistoricostringSim
RetornoViewLeilao2 3 campos
CampoTipoNullable
placastringSim
temRegistrobooleanNão
leiloesarray<LeilaoItemView>Sim
RetornoViewLeilao3 3 campos
CampoTipoNullable
placastringSim
temRegistrobooleanNão
leiloesarray<Leilao3ItemView>Sim
RetornoViewNacional 63 campos
CampoTipoNullable
placastringSim
placaMercosulstringSim
chassistringSim
renavamstringSim
chassiRemarcadostringSim
ultimaAtualizacaostringSim
municipiostringSim
ufstringSim
procedenciastringSim
tipostringSim
especiestringSim
tipoMontagemstringSim
marcaModelostringSim
anoModstringSim
anoFabstringSim
capPassagstringSim
corstringSim
potenciastringSim
cilindradasstringSim
carroceriastringSim
combustivelstringSim
cmtstringSim
pbtstringSim
eixosstringSim
nEixoAuxiliarstringSim
nEixoTraseirostringSim
nMotorstringSim
nCambiostringSim
situacaoVeiculostringSim
rfAtivostringSim
multaRENAINFstringSim
recallstringSim
restricaoRFBstringSim
indicadorSinistrostringSim
comunicadodeVendastringSim
pendenciaEmissaoDocumentostringSim
restricaoRENAJUDstringSim
nDocumentoProprietariostringSim
tipoDocumentoProprietariostringSim
nomeProprietariostringSim
nDocumentoFaturadostringSim
tipoDocumentoFaturadostringSim
ufFaturamentostringSim
categoriastringSim
dataAtualizacaostringSim
dataEmplacamentostringSim
capacidadeCargastringSim
numeroEixoTraseiroDiferencialstringSim
numeroTerceiroEixostringSim
tipoDocumentoImportadorastringSim
dataLimiteRestricaostringSim
numeroDistringSim
restricaoTipoTransacaostringSim
restricoesRestricaoFinanstringSim
restricaoNomeAgentestringSim
restricaoFinanciadostringSim
restricaoCpfCnpjFinanciadostringSim
restricaoDataInclusaostringSim
restricaoUmstringSim
restricaoDoisstringSim
restricaoTresstringSim
restricaoQuatrostringSim
restricoesAdicionaisstringSim
RetornoViewNacional2 51 campos
CampoTipoNullable
placastringSim
chassistringSim
renavamstringSim
chassiRemarcadostringSim
municipiostringSim
ufstringSim
procedenciastringSim
tipostringSim
especiestringSim
marcaModelostringSim
codigoMarcaModelostringSim
anoModstringSim
anoFabstringSim
capPassagstringSim
corstringSim
potenciastringSim
cilindradasstringSim
carroceriastringSim
combustivelstringSim
cmtstringSim
pbtstringSim
capacidadeCargastringSim
eixosstringSim
nEixoAuxiliarstringSim
nEixoTraseirostringSim
nMotorstringSim
nCambiostringSim
situacaoVeiculostringSim
rfAtivostringSim
multaRENAINFstringSim
recallstringSim
restricaoRFBstringSim
comunicadodeVendastringSim
pendenciaEmissaoDocumentostringSim
restricaoRENAJUDstringSim
nDocumentoProprietariostringSim
tipoDocumentoProprietariostringSim
nomeProprietariostringSim
nDocumentoFaturadostringSim
tipoDocumentoFaturadostringSim
categoriastringSim
dataEmissaoCRVstringSim
dataEmissaoCRLVstringSim
anoLicenciamentoPagostringSim
numeroCarroceriastringSim
numeroDistringSim
restricaoUmstringSim
restricaoDoisstringSim
restricaoTresstringSim
restricaoQuatrostringSim
restricoesAdicionaisstringSim
RetornoViewParecerTecnico 6 campos
CampoTipoNullable
placastringSim
descricaostringSim
resultadoPesquisastringSim
parecerTecnicostringSim
semaforostringSim
imagemstringSim
RetornoViewPfBasic 5 campos
CampoTipoNullable
cadastroobjectNão
pendenciasobjectNão
consultasAoDocumentoobjectNão
documentosRoubadosobjectNão
participacoesSocietariasobjectNão
RetornoViewPfMaster 10 campos
CampoTipoNullable
cadastroobjectNão
informacoesComplementaresobjectNão
scoreobjectNão
pendenciasobjectNão
consultasAoDocumentoobjectNão
documentosRoubadosobjectNão
acoesJudiciaisobjectNão
falenciasobjectNão
participacoesSocietariasobjectNão
chequesSustadosobjectNão
RetornoViewPfMid 7 campos
CampoTipoNullable
cadastroobjectNão
scoreobjectNão
pendenciasobjectNão
documentosRoubadosobjectNão
acoesJudiciaisobjectNão
falenciasobjectNão
participacoesSocietariasobjectNão
RetornoViewPjBasic 5 campos
CampoTipoNullable
cadastroobjectNão
pendenciasobjectNão
consultasAoDocumentoobjectNão
quadroSocietarioobjectNão
diretoriaobjectNão
RetornoViewPjMaster 8 campos
CampoTipoNullable
cadastroobjectNão
quadroSocietarioCompletoobjectNão
scoreobjectNão
pendenciasobjectNão
acoesJudiciaisobjectNão
falenciasobjectNão
consultasAoDocumentoobjectNão
chequesSustadosobjectNão
RetornoViewPjMid 7 campos
CampoTipoNullable
cadastroobjectNão
scoreobjectNão
pendenciasobjectNão
acoesJudiciaisobjectNão
falenciasobjectNão
quadroSocietarioobjectNão
diretoriaobjectNão
RetornoViewProcessos 7 campos
CampoTipoNullable
nomeRazaostringSim
documentostringSim
nomeFantasiastringSim
fundacaostringSim
naturezastringSim
contagemstringSim
processosarray<ProcessoView>Sim
RetornoViewProprietario 4 campos
CampoTipoNullable
codigointeger (int32)Não
mensagemstringSim
qtdVeiculosinteger (int32)Não
veiculosarray<Models_RetornoViews_VeiculoRegistro>Sim
RetornoViewProtesto 6 campos
CampoTipoNullable
documentostringSim
tipoDocumentostringSim
possuiProtestobooleanSim
quantidadeProtestosinteger (int32)Sim
totalRegistrosinteger (int32)Sim
protestosarray<ProtestoDetalhe>Sim
RetornoViewRemarketing 17 campos
CampoTipoNullable
existeRegistrobooleanNão
placastringSim
chassistringSim
descricaostringSim
resultadoPesquisastringSim
modelostringSim
situacaoChassistringSim
anoFabricacaostringSim
anoModelostringSim
combustivelstringSim
corstringSim
renavamstringSim
segmentostringSim
subSegmentostringSim
registrosRemarketingarray<RegistroRemarketingView>Sim
checkListobjectNão
fotosarray<string>Sim
RetornoViewRenainf 3 campos
CampoTipoNullable
mensagemstringSim
quantidadeOcorrenciasstringSim
ocorrenciasarray<OcorrenciaRenainfView>Sim
RetornoViewRenajud 17 campos
CampoTipoNullable
marcaModelostringSim
municipiostringSim
renavamstringSim
corstringSim
anoFabricacaostringSim
anoModelostringSim
chassistringSim
placastringSim
combustivelstringSim
especiestringSim
motorstringSim
procedenciastringSim
tipostringSim
mensagemstringSim
quantidadeOcorrenciasTotalstringSim
quantidadeBloqueioAtivostringSim
ocorrenciasarray<OcorrenciaRenajud>Sim
RetornoViewRenajud2 14 campos
CampoTipoNullable
placastringSim
placaAnteriorstringSim
chassistringSim
renavamstringSim
marcaModelostringSim
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
ufstringSim
proprietarioobjectNão
mensagemstringSim
quantidadeOcorrenciasTotalinteger (int32)Não
quantidadeBloqueioAtivointeger (int32)Não
quantidadeBaixadasinteger (int32)Não
ocorrenciasarray<OcorrenciaRenajud2>Sim
RetornoViewRouboFurto 10 campos
CampoTipoNullable
mensagemstringSim
existeOcorrenciastringSim
chassistringSim
placastringSim
marcaModelostringSim
anoModelostringSim
anoFabricacaostringSim
corstringSim
municipioEmplacamentostringSim
ocorrenciasarray<Ocorrencia>Sim
RetornoViewRouboFurto2 10 campos
CampoTipoNullable
mensagemstringSim
existeOcorrenciastringSim
chassistringSim
placastringSim
marcaModelostringSim
anoModelostringSim
anoFabricacaostringSim
corstringSim
municipioEmplacamentostringSim
ocorrenciasarray<Ocorrencia>Sim
RetornoViewSinistro 2 campos
CampoTipoNullable
indicioDeSinistrointeger (int32)Não
mensagemSinistrostringSim
RetornoViewValidacaoSeguros 5 campos
CampoTipoNullable
placastringSim
dataRespostastringSim
seguradorasarray<ValidacaoSeguroSeguradora>Sim
observacoesstringSim
informacoesImportantesarray<string>Sim
SituacaoDetalhe 2 campos
CampoTipoNullable
codigointeger (int32)Não
nomestringSim
SocioView 8 campos
CampoTipoNullable
documentoEmpresastringSim
razaoSocialEmpresastringSim
documentostringSim
nomestringSim
qualificacaostringSim
qualificacaoGlobalstringSim
percentualstringSim
datastringSim
TelefoneView 4 campos
CampoTipoNullable
tipostringSim
whatsappstringSim
dddstringSim
numerostringSim
TribunalRenajud2 2 campos
CampoTipoNullable
idstringSim
nomestringSim
ValidacaoSeguroSeguradora 6 campos
CampoTipoNullable
idSeguradorastringSim
seguradorastringSim
statusstringSim
codigoAceitacaostringSim
aceitacaostringSim
franquiastringSim
VeiculoConfirmacao 8 campos
CampoTipoNullable
placastringSim
marcaModelostringSim
corstringSim
chassistringSim
anoModelostringSim
anoFabricacaostringSim
nomeProprietariostringSim
documentoProprietariostringSim
VeiculoDetalhe 5 campos
CampoTipoNullable
placastringSim
renavamstringSim
anoFabricacaointeger (int32)Sim
anoModelointeger (int32)Sim
crvobjectNão
VendaDetalhe 4 campos
CampoTipoNullable
cidadeinteger (int32)Sim
datastringSim
valornumber (double)Sim
compradorSolicitantestringSim
VinculoView 3 campos
CampoTipoNullable
cpfstringSim
nomestringSim
grauVinculostringSim
WebhookClienteRequest 2 campos
CampoTipoNullable
urlstringSim
secretstringSim

Códigos de Erro

A API utiliza códigos HTTP padrão e retorna respostas JSON estruturadas em caso de erro.

Estrutura Padrão de Erro (Consultas)

{
  "type": "string",
  "title": "Descrição do erro",
  "status": 400,
  "detail": "Mensagem detalhada",
  "instance": "/api/Consultas/binnacional"
}

Estrutura Padrão de Erro (Comunicado de Venda)

{
  "sucesso": false,
  "mensagem": "Descrição do erro",
  "erro": {
    "categoria": "Validacao",
    "mensagem": "Detalhes do erro",
    "protocoloInterno": null,
    "situacao": null,
    "situacaoNome": null
  },
  "dados": null
}

Indisponibilidade temporária (Consultas)

Além das estruturas acima, uma consulta pode retornar indisponibilidade momentânea da fonte consultada. Nesse caso a resposta traz apenas idConsulta, mensagem e dataConsulta, com mensagem genérica:

{
  "idConsulta": "00000000-0000-0000-0000-000000000000",
  "mensagem": "Consulta indisponível no momento. Tente novamente mais tarde.",
  "dataConsulta": "18/08/2026 16:09:58"
}

Trate essa resposta como transitória: repita a chamada mais tarde (ver Boas Práticas — retentativas com backoff).

Tabela de Códigos HTTP

CódigoNomeDescriçãoAção Recomendada
200OKRequisição processada com sucessoProcessar os dados retornados
400Bad RequestParâmetros inválidos ou ausentesVerificar parâmetros enviados e formato dos dados
401UnauthorizedToken JWT ausente, inválido ou expiradoRenovar token via /api/Auth/login
404Not FoundRecurso não encontrado (ex: protocolo inexistente)Verificar identificador enviado
409ConflictDuplicação (ex: comunicado já existente para a placa)Verificar registros existentes antes de cadastrar
422Unprocessable EntityDados válidos porém não processáveis (ex: placa não encontrada no DETRAN)Revisar dados do veículo ou condutor
500Internal Server ErrorErro interno no servidorTentar novamente; se persistir, contatar suporte

Categorias de Erro (Comunicado de Venda)

CategoriaDescrição
ValidacaoCampos obrigatórios ausentes ou com formato inválido
NaoAutorizadoToken inválido ou sem permissão para a operação
DuplicacaoComunicado já registrado para o veículo/placa
NaoEncontradoProtocolo ou recurso não encontrado
ProcessamentoErro ao processar dados junto ao DETRAN
ErroInternoFalha interna no servidor

Guia de Integração

1. Padrão de Chamada — Consultas Veiculares

Todos os endpoints de Consultas seguem o mesmo padrão:

POST /api/Consultas/binnacional?parametro=ABC1D23
Authorization: Bearer eyJhbGci...
Content-Length: 0

2. Estrutura de Resposta — Consultas

Toda consulta retorna um objeto com dois campos principais:

{
  "resposta": {
    "idConsulta": "guid-da-consulta",
    "dataConsulta": "2025-01-15T10:30:00",
    "parametro": "ABC1D23",
    "usuario": "seu_usuario",
    "tipoConsulta": "binnacional",
    "tempoTotalMs": 1250
  },
  "retorno": {
    // dados específicos de cada consulta
  }
}

3. Exemplo Completo — Python

import requests

BASE_URL = "https://api.avaliservice.com.br"

# 1. Login
resp = requests.post(f"{BASE_URL}/api/Auth/login", json={
    "username": "seu_usuario",
    "password": "sua_senha"
})
token = resp.json()["token"]

# 2. Consulta
headers = {"Authorization": f"Bearer {token}"}
consulta = requests.post(
    f"{BASE_URL}/api/Consultas/binnacional",
    params={"parametro": "ABC1D23"},
    headers=headers
)
dados = consulta.json()
print(dados["retorno"])

4. Exemplo Completo — C#

using var client = new HttpClient();
client.BaseAddress = new Uri("https://api.avaliservice.com.br");

// 1. Login
var loginResp = await client.PostAsJsonAsync("/api/Auth/login", new {
    username = "seu_usuario",
    password = "sua_senha"
});
var loginData = await loginResp.Content.ReadFromJsonAsync<LoginResponse>();
client.DefaultRequestHeaders.Authorization = 
    new AuthenticationHeaderValue("Bearer", loginData.Token);

// 2. Consulta
var resp = await client.PostAsync(
    "/api/Consultas/binnacional?parametro=ABC1D23", null);
var result = await resp.Content.ReadAsStringAsync();

5. Exemplo Completo — Node.js

const BASE_URL = "https://api.avaliservice.com.br";

// 1. Login
const loginResp = await fetch(`${BASE_URL}/api/Auth/login`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ username: "seu_usuario", password: "sua_senha" })
});
const { token } = await loginResp.json();

// 2. Consulta
const resp = await fetch(
  `${BASE_URL}/api/Consultas/binnacional?parametro=ABC1D23`,
  { method: "POST", headers: { "Authorization": `Bearer ${token}` } }
);
const dados = await resp.json();
console.log(dados.retorno);

6. Boas Práticas

PráticaDetalhes
Reutilize o tokenO token JWT tem validade de 24 horas. Autentique uma vez e reutilize nas chamadas subsequentes. Renove quando receber 401.
Trate erros por código HTTPUse o código HTTP (400, 401, 404, etc.) como primeiro filtro. O corpo da resposta traz detalhes.
Valide parâmetros antes de enviarPlacas devem seguir o formato ABC1D23 ou ABC1234. CPFs devem ter exatamente 11 dígitos.
Implemente retentativasPara erros 500 ou timeouts, implemente retentativa com backoff exponencial (ex: 1s, 2s, 4s).
Respeite os formatosDatas: DD/MM/AAAA para ComunicadoVenda. CEP: 8 dígitos sem hífen. UF: sigla maiúscula.
Consultas em lotePara múltiplas consultas, use chamadas paralelas com limite de concorrência (recomendado: 5-10 simultâneas).