SUFRAMA - Comprovante de Inscrição e de Situação Cadastral

O que é

Na Consulta SUFRAMA - Comprovante de Inscrição e de Situação Cadastral - é possível verificar se o cadastro encontra-se regular.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/suframa/comprovante-inscricao-situacao-cadastral

URL Base:

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

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

Callback

String

Não

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

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

Nome

Tipo

Obrigatório?

Descrição

cpfCnpj

string

Somente se rntrc não for informado

CPF ou CNPJ do transportador, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

Estrutura da resposta

Status

Significado

Descrição

Informações retornadas

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

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

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos quando você faz a requisição:

Status 201

Status 422

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

Valores possíveis do campo “status“

Status

Significado

Status

Significado

ativa

O registro encontra-se ativa.

erro

Nenhum registro encontrado para os dados informados

Resposta

{ "status": "ativa", "cpfCnpj": "99.999.999/9999-99", "nome": "Empresa S/A", "dataCadastro": "04/06/2018", "numeroInscricao": 999999999, "pdf": "{PDF EM BASE64}" }

Resposta com erro

{ "status": "erro", "mensagem": "CNPJ/CPF Inválido.", "pdf": "{PDF EM BASE64}" }