v1

latestOpenAPI 3.0.02026-08-049274312.1 KB
ATPVe

ATPVe

post/atpve

Request body

Example request

{
  "Consulta": {
    "IdConsulta": "531",
    "Operacao": "7",
    "Protocolo": "xxxxb11x-110x-111x-111x-11x0xx1xx0xx"
  }
}

Response

Resposta da consulta.

  • Código 1: Sucesso.
  • Código 2: Dado não encontrado na base de dados.
  • Código 3: Erro na consulta.

Example response

{
  "CONSULTA": {
    "CODIGORESPOSTA": "XXXXXXXX",
    "DATAHORA": "DD/MM/AAAA HH:MM:SS",
    "LOGON": "XXXXX",
    "IDCONSULTA": "XXX"
  },
  "RESPOSTA": {
    "CODIGO": "1",
    "OPERACAO": {
      "CODIGO": "7"
    },
    "ATPVe": {
      "VENDEDOR": {
        "TIPO_PESSOA": "F",
        "DOCUMENTO": "XXXXXXXXXXX",
        "NOME": "NOME ANONIMIZADO",
        "EMAIL": "email@anonimizado.com",
        "RG": "XXXXXXXXXX",
        "RG_EMISSOR": "SSP"
      },
      "COMPRADOR": {
        "TIPO_PESSOA": "F",
        "DOCUMENTO": "XXXXXXXXXXX",
        "NOME": "NOME ANONIMIZADO",
        "EMAIL": "email@anonimizado.com",
        "RG": "XXXXXXXXX",
        "RG_EMISSOR": "SSP",
        "ENDERECO": {
          "CEP": "00000000",
          "LOGRADOURO": "RUA ANONIMIZADA",
          "NUMERO": "XXX",
          "BAIRRO": "BAIRRO ANONIMIZADO",
          "CIDADE": "CIDADE ANONIMIZADA",
          "UF": "XX"
        }
      },
      "VENDA": {
        "DATA_VENDA": "DD/MM/AAAA",
        "VALOR": "00000,00",
        "CIDADE": "CIDADE ANONIMIZADA",
        "UF": "XX"
      },
      "VEICULO": {
        "PLACA": "XXX0000",
        "RENAVAM": "XXXXXXXXXXX",
        "CHASSI": "XXXXXXXXXXXXXXXXX",
        "ANO_FABRICACAO": "AAAA",
        "ANO_MODELO": "AAAA",
        "KILOMETRAGEM": "000000",
        "MARCA": "MARCA ANONIMIZADA",
        "COR": "COR ANONIMIZADA",
        "CRV": {
          "NUMERO": "XXXXXXXXXXXX",
          "CODIGO_SEGURANCA": "XXXXXXXXXXX",
          "NUMERO_VIA": "X",
          "DATA_EMISSAO": "DD/MM/AAAA",
          "UF_EMISSAO": "XX"
        }
      },
      "AUTORIZACAO": {
        "ARQUIVOPDF_Base64": "DADOS_ANONIMIZADOS_BASE64",
        "URL": "https://webservice.credify.com.br/pdfs/aptveXXXXXXXXXXXXX.pdf"
      },
      "SITUACAO_ATUAL": {
        "CODIGO": "5",
        "DESCRICAO": "COMUNICADA"
      }
    }
  }
}