ATPVe — Registrar | Credify API

curl -X POST https://api.credify.com.br/atpveregistrar \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "Consulta": {
    "IdConsulta": "531",
    "Operacao": "2",
    "Protocolo": ""
  }
}'

{
  "CONSULTA": {
    "CODIGORESPOSTA": "51121769",
    "DATAHORA": "01/11/2024 12:55:45",
    "IDCONSULTA": "531",
    "LOGON": "XXXXX"
  },
  "RESPOSTA": {
    "ATPVe": {
      "AUTORIZACAO": {
        "ARQUIVOPDF_Base64": "JVBERi0xLjUKJfbk/N8KMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1Byb2R1Y2VyIChSZW5hdmFtKQovQ3JlYXRvciAoUmVuYXZhbSkKL0NyZWF0aW9uRGF0ZSAoRDoyMDIzMTAzMTE...",
        "URL": "https://webservice.credify.com.br/pdfs/aptvexxxxxxxxxxxxx.pdf"
      },
      "SITUACAO_ATUAL": {
        "CODIGO": "5",
        "DESCRICAO": "COMUNICADA"
      }
    },
    "CODIGO": "1",
    "OPERACAO": {
      "CODIGO": "2"
    }
  }
}

Esta operação finaliza a emissão do documento ATPVe (Autorização para Transferência de Propriedade de Veículo em meio eletrônico), registrando e autenticando o documento após o cadastro inicial.

A resposta pode seguir dois caminhos:

Documento direto: retorna o PDF da autorização — o fluxo se encerra aqui.
Novo protocolo: retorna um novo protocolo, que deve ser utilizado na operação Recuperar para obter o documento.

Endpoint real: POST /atpve — o mesmo da operação Cadastrar. O que muda é o valor de Operacao (2) e o corpo enviado (Protocolo em vez do payload completo). Esta página usa um caminho distinto apenas para facilitar a navegação na documentação.

Utilize o Protocolo retornado pela operação Cadastrar para finalizar a emissão.

TABELA DE CAMPOS DE REQUISIÇÃO

Campo	Descrição	Formato	Obrigatório
IdConsulta	Identificador da consulta. Valor fixo: `531`.	string	Sim
Operacao	Código da operação. Valor fixo: `2` (registrar).	string	Sim
Protocolo	Protocolo retornado pela operação Cadastrar.	string	Sim

TABELA DE CAMPOS DE RETORNO

Cabeçalho da Resposta — CONSULTA

Campo	Descrição	Formato
CONSULTA.CODIGORESPOSTA	Número do protocolo de retorno gerado pelo servidor da API.	string
CONSULTA.DATAHORA	Data e hora exata em que o processamento foi concluído.	string
CONSULTA.LOGON	Código de identificação da credencial de acesso que realizou a chamada.	string
CONSULTA.IDCONSULTA	Código identificador retornado para conciliação com o enviado na requisição.	string

📄 Documento da Autorização — RESPOSTA.ATPVe.AUTORIZACAO

Presente quando o documento é retornado diretamente (fluxo encerrado).

Campo	Descrição	Formato
RESPOSTA.CODIGO	Código do resultado da consulta.	string
RESPOSTA.OPERACAO.CODIGO	Código da operação executada (`2` = registrar).	string
RESPOSTA.ATPVe.AUTORIZACAO.ARQUIVOPDF_Base64	Conteúdo do PDF da autorização codificado em Base64.	string
RESPOSTA.ATPVe.AUTORIZACAO.URL	Link para download do PDF da autorização.	string

📌 Situação Atual — RESPOSTA.ATPVe.SITUACAO_ATUAL

Campo	Descrição	Formato
SITUACAO_ATUAL.CODIGO	Código da situação do processo de transferência.	string
SITUACAO_ATUAL.DESCRICAO	Descrição da situação (ex.: `COMUNICADA`).	string
SITUACAO_ATUAL.PROTOCOLO	Novo protocolo, retornado quando o documento não vem diretamente. Utilize-o na operação Recuperar.	string

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Objeto de consulta com o protocolo retornado pela operação Cadastrar.

ConsultaobjectRequired

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.

Errors

400

Bad Request Error

401

Unauthorized Error