Garantias locatícias

Contrato 5085d901ceed

API pública para parceiros criarem, manterem e acompanharem garantias locatícias e consultarem seus extratos financeiros. Parceiros respondem às propostas de análise por meio de aceite ou recusa; eles nunca aprovam, reprovam, reabrem ou solicitam mais dados da análise.

• Produção: https://api.morus.finance/rental-insurance
• Sandbox: https://api-sandbox.morus.finance/rental-insurance

Listar garantias locatícias

GET/v1/rental-insurances

Requer ri:rental-insurances:read. Os resultados contêm somente dados da empresa do token.

Escopo necessário: ri:rental-insurances:read

Parameters

Parameter	In	Type	Required	Description
propertyExternalId	query	string	no
tenantCpfCnpj	query	string	no
tenantName	query	string	no
status	query	array<RentalInsuranceStatus>	no	Repita o parâmetro para selecionar mais de um status.
page	query	integer	no	Número da página iniciado em zero. Valores negativos são tratados como zero.
pageSize	query	integer	no	Os valores são limitados ao intervalo de 1 a 200.

Responses

Status	Description	Response headers
200	Página de garantias	—
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—

Response body (200)

Content-Type: application/json

{
  "_embedded": {
    "rentalInsurances": [
      {
        "id": 0,
        "externalId": "string",
        "status": "under_review",
        "creator": {
          "name": "string",
          "serviceAccount": true
        },
        "tenant": {
          "cpfCnpj": "string",
          "name": "string",
          "email": "string",
          "birthDate": "2026-09-15",
          "phoneNumber": "string",
          "profession": "string"
        },
        "coTenants": [
          {
            "cpfCnpj": "string",
            "name": "string",
            "email": "string",
            "birthDate": "2026-09-15",
            "phoneNumber": "string"
          }
        ],
        "property": {
          "externalId": "string",
          "type": "string",
          "address": "string"
        },
        "rentalAmount": 0,
        "condoFee": 0,
        "propertyTax": 0,
        "otherFees": 0,
        "installmentAmount": 0,
        "setupFee": 0,
        "coverageLimit": 0,
        "rentCoverageLimit": 0,
        "remainingCoverageAmount": 0,
        "rentRemainingCoverageAmount": 0,
        "startBillingDate": "2026-09-15",
        "terminationDate": "2026-09-15",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  },
  "_links": {},
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

Exemplo interativoMonte e teste esta requisição

propertyExternalId tenantCpfCnpj tenantName status page pageSize

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Criar uma garantia locatícia

POST/v1/rental-insurances

Requer ri:rental-insurances:write. A garantia entra em análise com o status under_review; esta operação nunca decide o resultado da análise.

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.

Request body

Content-Type: application/json

{
  "externalId": "RI-2026-0042",
  "tenant": {
    "cpfCnpj": "52998224725",
    "name": "Ana Souza",
    "email": "ana@example.com",
    "birthDate": "1990-04-18",
    "phoneNumber": "+5511999999999",
    "profession": "Engenheira"
  },
  "property": {
    "externalId": "UNIT-804",
    "type": "apartment",
    "address": {
      "zipCode": "01310100",
      "street": "Avenida Paulista",
      "number": "1000",
      "complement": "Apto 804",
      "neighborhood": "Bela Vista",
      "city": "São Paulo",
      "state": "SP"
    }
  },
  "coTenants": [],
  "rentalAmount": 3200,
  "condoFee": 650,
  "propertyTax": 180,
  "otherFees": 0,
  "setupFee": 120
}

Responses

Status	Description	Response headers
201	Garantia criada	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—

Response body (201)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

Idempotency-Key *

Request body

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Consultar uma garantia locatícia

GET/v1/rental-insurances/{id}

Requer ri:rental-insurances:read.

Escopo necessário: ri:rental-insurances:read

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes

Responses

Status	Description	Response headers
200	Garantia encontrada	ETag
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—

Response body (200)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id *

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Atualizar uma garantia locatícia

PATCH/v1/rental-insurances/{id}

Requer ri:rental-insurances:write, uma chave de idempotência e o ETag atual. Somente os campos presentes no merge patch são alterados. Uma alteração monetária pode iniciar uma nova análise; uma alteração contratual pode invalidar e reemitir um contrato aceito. A resposta informa esses efeitos. O CPF/CNPJ do inquilino identifica a pessoa e não pode ser atualizado.

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.
If-Match	header	string	yes	ETag fraco retornado pela leitura ou escrita mais recente, por exemplo W/"4".

Request body

Content-Type: application/merge-patch+json

{
  "externalId": "string",
  "tenant": {
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "property": {
    "externalId": "string",
    "type": "apartment",
    "address": {
      "zipCode": "string",
      "street": "string",
      "number": "string",
      "complement": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string"
    }
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "setupFee": 0
}

Responses

Status	Description	Response headers
200	Garantia após a escrita	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—
412	If-Match não contém a versão atual do recurso	—
428	If-Match não foi informado	—

Response body (200)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * Idempotency-Key * If-Match *

Request body

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Listar histórico da garantia

GET/v1/rental-insurances/{id}/history

Requer ri:rental-insurances:read.

Escopo necessário: ri:rental-insurances:read

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes

Responses

Status	Description	Response headers
200	Histórico em ordem cronológica	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—

Response body (200)

Content-Type: application/json

[
  {
    "creator": {
      "name": "string",
      "serviceAccount": true
    },
    "comment": "string",
    "previousStatus": "string",
    "status": "string",
    "documents": [
      {
        "id": 0,
        "fileName": "string"
      }
    ],
    "createdAt": "string"
  }
]

Exemplo interativoMonte e teste esta requisição

id *

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Adicionar comentário

POST/v1/rental-insurances/{id}/comments

Requer ri:rental-insurances:write. O comentário é público e fica visível no histórico da garantia para o parceiro e para os operadores da Morus. A operação não altera os dados, o status, o responsável nem a versão da garantia.

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.

Request body

Content-Type: application/json

{
  "comment": "Documentação complementar enviada."
}

Responses

Status	Description	Response headers
201	Comentário adicionado	Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—

Response body (201)

Content-Type: application/json

{
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "comment": "string",
  "previousStatus": "string",
  "status": "string",
  "documents": [
    {
      "id": 0,
      "fileName": "string"
    }
  ],
  "createdAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * Idempotency-Key *

Request body

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Listar assinaturas do contrato

GET/v1/rental-insurances/{id}/signatures

Requer ri:rental-insurances:read. Registros pendentes não incluem url.

Escopo necessário: ri:rental-insurances:read

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes

Responses

Status	Description	Response headers
200	Estado atual das assinaturas	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—

Response body (200)

Content-Type: application/json

[
  {
    "role": "document",
    "cpfCnpj": "string",
    "name": "string",
    "url": "string",
    "status": "pending"
  }
]

Exemplo interativoMonte e teste esta requisição

id *

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Aceitar uma proposta aprovada pela análise

POST/v1/rental-insurances/{id}/accept

Requer ri:rental-insurances:write. Esta operação aceita uma proposta já aprovada e pode solicitar a assinatura do contrato. Ela não aprova a garantia.

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.

Responses

Status	Description	Response headers
200	Garantia após a escrita	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—

Response body (200)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * Idempotency-Key *

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Recusar uma proposta aprovada pela análise

POST/v1/rental-insurances/{id}/refuse

Requer ri:rental-insurances:write. Esta operação recusa, em nome do inquilino, uma proposta já aprovada. Ela não reprova a garantia na análise.

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.

Responses

Status	Description	Response headers
200	Garantia após a escrita	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—

Response body (200)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * Idempotency-Key *

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Adicionar um corresponsável

POST/v1/rental-insurances/{id}/co-tenants

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.
If-Match	header	string	yes	ETag fraco retornado pela leitura ou escrita mais recente, por exemplo W/"4".

Request body

Content-Type: application/json

{
  "cpfCnpj": "string",
  "name": "string",
  "email": "string",
  "birthDate": "2026-09-15",
  "phoneNumber": "string"
}

Responses

Status	Description	Response headers
201	Garantia após a escrita	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—
412	If-Match não contém a versão atual do recurso	—
428	If-Match não foi informado	—

Response body (201)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * Idempotency-Key * If-Match *

Request body

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Atualizar um corresponsável

PATCH/v1/rental-insurances/{id}/co-tenants/{cpfCnpj}

O CPF/CNPJ identifica o corresponsável pelo parâmetro do path e não pode ser atualizado.

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
cpfCnpj	path	string	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.
If-Match	header	string	yes	ETag fraco retornado pela leitura ou escrita mais recente, por exemplo W/"4".

Request body

Content-Type: application/merge-patch+json

{
  "name": "string",
  "email": "string",
  "birthDate": "2026-09-15",
  "phoneNumber": "string"
}

Responses

Status	Description	Response headers
200	Garantia após a escrita	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—
412	If-Match não contém a versão atual do recurso	—
428	If-Match não foi informado	—

Response body (200)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * cpfCnpj * Idempotency-Key * If-Match *

Request body

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Remover um corresponsável

DELETE/v1/rental-insurances/{id}/co-tenants/{cpfCnpj}

Escopo necessário: ri:rental-insurances:write

Parameters

Parameter	In	Type	Required	Description
id	path	integer (int64)	yes
cpfCnpj	path	string	yes
Idempotency-Key	header	string	yes	Chave única para uma operação lógica de escrita, com até 255 caracteres. Reutilizá-la com o mesmo método, caminho e corpo repete a resposta 2xx armazenada. Reutilizá-la em outra requisição é rejeitado.
If-Match	header	string	yes	ETag fraco retornado pela leitura ou escrita mais recente, por exemplo W/"4".

Responses

Status	Description	Response headers
200	Garantia após a escrita	ETag, Morus-Effects, Idempotent-Replay
400	Parâmetros, corpo, estado ou chave de idempotência inválidos	—
401	Token Bearer ausente ou inválido	—
403	O token não contém o escopo necessário	—
404	Garantia não encontrada na empresa do token	—
409	Uma escrita com a mesma chave de idempotência está em andamento ou a operação conflita com o estado atual	—
412	If-Match não contém a versão atual do recurso	—
428	If-Match não foi informado	—

Response body (200)

Content-Type: application/json

{
  "id": 0,
  "externalId": "string",
  "status": "under_review",
  "creator": {
    "name": "string",
    "serviceAccount": true
  },
  "tenant": {
    "cpfCnpj": "string",
    "name": "string",
    "email": "string",
    "birthDate": "2026-09-15",
    "phoneNumber": "string",
    "profession": "string"
  },
  "coTenants": [
    {
      "cpfCnpj": "string",
      "name": "string",
      "email": "string",
      "birthDate": "2026-09-15",
      "phoneNumber": "string"
    }
  ],
  "property": {
    "externalId": "string",
    "type": "string",
    "address": "string"
  },
  "rentalAmount": 0,
  "condoFee": 0,
  "propertyTax": 0,
  "otherFees": 0,
  "installmentAmount": 0,
  "setupFee": 0,
  "coverageLimit": 0,
  "rentCoverageLimit": 0,
  "remainingCoverageAmount": 0,
  "rentRemainingCoverageAmount": 0,
  "startBillingDate": "2026-09-15",
  "terminationDate": "2026-09-15",
  "createdAt": "string",
  "updatedAt": "string"
}

Exemplo interativoMonte e teste esta requisição

id * cpfCnpj * Idempotency-Key * If-Match *

Credenciais

Client ID Client secret

As credenciais permanecem somente na memória desta página.

Executar no sandboxCopiar cURL

cURL

Data models

RentalInsuranceStatus

Valores: under_review, information_requested, approved, declined, expired, accepted, declined_by_tenant, active, terminated, archived

PropertyType

Valores: apartment, house, commercial

SignatureRole

Valores: document, tenant, co_tenant

SignatureStatus

Valores: pending, awaiting_signature, signed, refused

StatementType

Valores: charge_paid, charge_refunded, revenue_shared, fee, transfer_sent, transfer_refunded, transfer_received

AddressCreate

Field	Type	Required	Description
zipCode	string	yes	—
street	string	yes	—
number	string	yes	—
complement	string | null	no	—
neighborhood	string	yes	—
city	string	yes	—
state	string	yes	—

AddressPatch

Field	Type	Required	Description
zipCode	string	no	—
street	string	no	—
number	string	no	—
complement	string	no	—
neighborhood	string	no	—
city	string	no	—
state	string	no	—

Address

Field	Type	Required	Description
zipCode	string | null	yes	—
street	string | null	yes	—
number	string | null	yes	—
complement	string | null	yes	—
neighborhood	string | null	yes	—
city	string | null	yes	—
state	string | null	yes	—

TenantCreate

Field	Type	Required	Description
cpfCnpj	string	yes	—
name	string	yes	—
email	string (email) | null	no	—
birthDate	string (date) | null	no	—
phoneNumber	string | null	no	—
profession	string | null	no	—

TenantPatch

Field	Type	Required	Description
name	string	no	—
email	string (email)	no	—
birthDate	string (date)	no	—
phoneNumber	string	no	—
profession	string	no	—

Tenant

Field	Type	Required	Description
cpfCnpj	string | null	yes	—
name	string | null	yes	—
email	string | null	yes	—
birthDate	string (date) | null	yes	—
phoneNumber	string | null	yes	—
profession	string | null	yes	—

CoTenantCreate

Field	Type	Required	Description
cpfCnpj	string	yes	—
name	string	yes	—
email	string (email) | null	no	—
birthDate	string (date) | null	no	—
phoneNumber	string | null	no	—

CoTenantPatch

Field	Type	Required	Description
name	string	no	—
email	string (email)	no	—
birthDate	string (date)	no	—
phoneNumber	string	no	—

CoTenant

Field	Type	Required	Description
cpfCnpj	string | null	yes	—
name	string | null	yes	—
email	string | null	yes	—
birthDate	string (date) | null	yes	—
phoneNumber	string | null	yes	—

PropertyCreate

Field	Type	Required	Description
externalId	string	yes	—
type	PropertyType	yes	Valores: apartment, house, commercial
address	AddressCreate	yes	—

PropertyPatch

Field	Type	Required	Description
externalId	string	no	—
type	PropertyType	no	Valores: apartment, house, commercial
address	AddressPatch	no	—

Property

Field	Type	Required	Description
externalId	string | null	yes	—
type	object	yes	—
address	object	yes	—

RentalInsuranceCreate

Field	Type	Required	Description
externalId	string | null	no	—
tenant	TenantCreate	yes	—
property	PropertyCreate	yes	—
coTenants	array<CoTenantCreate>	no	—
rentalAmount	number	yes	—
condoFee	number | null	no	—
propertyTax	number | null	no	—
otherFees	number | null	no	—
setupFee	number | null	no	—

RentalInsurancePatch

Field	Type	Required	Description
externalId	string	no	—
tenant	TenantPatch	no	—
property	PropertyPatch	no	—
rentalAmount	number	no	—
condoFee	number	no	—
propertyTax	number	no	—
otherFees	number	no	—
setupFee	number	no	—

PartnerRentalInsuranceCommentRequest

Field	Type	Required	Description
comment	string	yes	—

PartnerCreator

Field	Type	Required	Description
name	string	yes	—
serviceAccount	boolean	yes	—

RentalInsurance

Field	Type	Required	Description
id	integer (int64)	yes	—
externalId	string | null	yes	—
status	RentalInsuranceStatus	yes	Valores: under_review, information_requested, approved, declined, expired, accepted, declined_by_tenant, active, terminated, archived
creator	PartnerCreator	yes	—
tenant	Tenant	yes	—
coTenants	array<CoTenant>	yes	—
property	Property	yes	—
rentalAmount	number	yes	—
condoFee	number | null	yes	—
propertyTax	number | null	yes	—
otherFees	number | null	yes	—
installmentAmount	number | null	yes	—
setupFee	number | null	yes	—
coverageLimit	number | null	yes	—
rentCoverageLimit	number | null	yes	—
remainingCoverageAmount	number | null	yes	—
rentRemainingCoverageAmount	number | null	yes	—
startBillingDate	string (date) | null	yes	—
terminationDate	string (date) | null	yes	—
createdAt	string | null	yes	—
updatedAt	string | null	yes	—

RentalInsuranceHistory

Field	Type	Required	Description
creator	PartnerCreator	yes	—
comment	string | null	yes	—
previousStatus	object	yes	—
status	object	yes	—
documents	array<Document>	yes	—
createdAt	string | null	yes	—

Document

Field	Type	Required	Description
id	integer (int64)	yes	—
fileName	string | null	yes	—

Signature

Field	Type	Required	Description
role	SignatureRole	yes	Valores: document, tenant, co_tenant
cpfCnpj	string | null	yes	—
name	string | null	yes	—
url	string (uri)	no	—
status	SignatureStatus	yes	Valores: pending, awaiting_signature, signed, refused

Balance

Field	Type	Required	Description
balance	number	yes	—
credits	number	yes	—
debits	number	yes	—

DailyBalance

Field	Type	Required	Description
date	string (date)	yes	—
openingBalance	number	yes	—
closingBalance	number	yes	—
credits	number	yes	—
debits	number	yes	—

StatementEntry

Field	Type	Required	Description
id	integer (int64)	yes	—
date	string (date)	yes	—
description	string | null	yes	—
amount	number	yes	—
type	StatementType	yes	Valores: charge_paid, charge_refunded, revenue_shared, fee, transfer_sent, transfer_refunded, transfer_received

PageMetadata

Field	Type	Required	Description
size	integer	yes	—
totalElements	integer (int64)	yes	—
totalPages	integer	yes	—
number	integer	yes	—

Link

Field	Type	Required	Description
href	string (uri)	yes	—

Links

RentalInsurancePage

Field	Type	Required	Description
_embedded	object	no	—
_links	Links	yes	—
page	PageMetadata	yes	—

StatementPage

Field	Type	Required	Description
_embedded	object	no	—
_links	Links	yes	—
page	PageMetadata	yes	—

Error

Field	Type	Required	Description
code	string	yes	—
message	string	yes	—
timestamp	string (date-time)	yes	—
details	array<string>	no	—
correlationId	string	no	—