Registradores - Matricula Online

O que é

Na consulta Registradores - Matrícula Online é a visualização da imagem da matrícula do imóvel, tal como a existente no cartório.

Veja mais informações em nossa central de ajuda: Registradores - Matricula Online

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/registradores/matricula-online

URL Base:

https://api.plexi.com.br/

Parâmetros do header

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome	Tipo	Obrigatório?	Descrição
email	string	Sim	E-mail de login
senha	string	Sim	Senha para login
uf	string	Sim	Estado do cartório. Único valor possível atualmente é `sp`
cidade	string	Sim	Cidade do cartório. Único valor possível atualmente é `sao_paulo`
cartorio	integer	Sim	Número do cartório. Valores de `1` a `18` são suportados.
matricula	string	Sim	Matricula do imóvel

Estrutura da resposta

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

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

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

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

Exemplos de retornos do resultado da pesquisa

Valores possíveis do campo “status“

Status	Significado
indefinido	Status padrão quando é retornado a matricula do imóvel.
erro	Erro ao buscar informações

Respostas com registro encontrado

{
  "status": "indefinido",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "A matrícula informada não foi encontrada para visualização.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

{
  "status": "erro",
  "mensagem": "Não há saldo suficiente para completar essa operação.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

{
  "status": "erro",
  "mensagem": "E-mail e/ou Senha incorretos!",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}