Page Comparison

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.

Veja mais informações em nossa central de ajuda: Secretaria do Patrimônio da União - Certidão de Situação de Ocupação/Aforamento

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/spu/certidao-situacao-ocupacao-aforamento

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
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

Retornos possíveis da requisição

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

Status 201

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

...

Code Block
{ "message": "The given data was invalid.", "errors": { "cpfCnpj": [ "CPF ou CNPJ inválido" ] } }

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

Valores possíveis do campo “status“

...

Versions Compared

Old Version 5

New Version 6

Key