Secretaria do Patrimônio da União - Certidão de Situação de Ocupação/Aforamento

O que é#

Com a certidão de Situação de Ocupação/Aforamento você pode verificar o foreiro ou ocupante de um imóvel disponibilizado pela Secretaria do Patrimônio da União.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/spu/certidao-situacao-ocupacao-aforamento

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
cpfCnpj	string	Somente se `rip` não for informado	CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99
rip	string	Somente se `cpfCnpj` não for informado	RIP 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.

JSON

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

Status 422

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

JSON

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

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

Valores possíveis do campo "status"

Status	Significado
inscrito	Imóvel possui certidão.
indefinido	Não foi possível determinar a certidão.
erro	Não há imóveis ou RIP inválido.

Resposta com registro encontrado

JSON

{
    "status": "inscrito",
    "numeroRip": "9999999999999",
    "regimeUtilizacao": "Ocupação",
    "cpfCnpj": "999.999.999-99",
    "responsavelAtual": "FULANO DE TAL",
    "enderecoImovel": {
        "logradouro": "AV. BRASIL, QUADRA 999 LOTE 999",
        "cep": "00000-000",
        "bairro": "NOME BAIRRO",
        "cidade": "NOME CIDADE",
        "uf": "RJ"
    },
    "caracteristicaImovel": {
        "natureza": "Urbano",
        "conceituacao": "ACRESCIDO DE MARINHA",
        "fracaoIdeal": 1,
        "areaTotalTerreno": 9999.9,
        "areaTotalUniao": 9999.9
    },
    "observacao": "Esta Certidão não é válida para transferência e registro de imóvel junto aos cartórios, órgãos públicos e instituições financeiras",
    "dataHoraEmissao": "01/01/2020 10:00:00",
    "codigoControleCertidao": "4ABC.3ABC.2ABC.1ABC",
    "pdf": "{PDF EM BASE64}"
}

JSON

{
  "status": "indefinido",
  "imoveis": [
      {
          "rip": "9999999999999",
          "endereco": "AV. BRASIL, QUADRA 999 LOTE 999"
      },
      {
          "rip": "9999999999998",
          "endereco": "AV. BRASIL, QUADRA 999 LOTE 999"
      },
      {
          "rip": "9999999999997",
          "endereco": "AV. BRASIL, QUADRA 999 LOTE 999"
      }
    ],
  "pdf": "{PDF EM BASE64}"
}

Resposta com erro

JSON

{
    "status": "erro",
    "mensagem": "Não foi possível encontrar registros para essa consulta. Não há imóveis.",
    "pdf": "{PDF EM BASE64}"
}

JSON

{
    "status": "erro",
    "mensagem": "Parametros de busca inválido. RIP inválido",
    "pdf": "{PDF EM BASE64}"
}