1. Autenticação
Homfy Public API
  • Bem vindo
  • Autenticação
    • Emitir token
      POST
    • Renovar token
      POST
  • Empreendimento
    • Cadastrar empreendimento
      POST
    • Atualizar empreendimento
      PUT
    • Cadastrar empreendimentos em lote
      POST
    • Consultar empreendimento
      POST
    • Vincular imóveis ao empreendimento
      POST
  • Imóvel
    • Cadastrar imóvel
      POST
    • Atualizar imóvel
      PUT
    • Cadastrar imóveis em lote
      POST
    • Consultar detalhes do imóvel
      POST
    • Enviar fotos — passo 1: obter URLs
      POST
    • Enviar fotos — passo 2: concluir
      POST
    • Andamento do processamento das fotos
      POST
    • Enviar documento — passo 1: obter URL
      POST
    • Enviar documento — passo 2: concluir
      POST
    • Buscar imóveis
      POST
  • Proprietário
    • Cadastrar proprietário
      POST
    • Atualizar proprietário
      PUT
    • Cadastrar proprietários em lote
      POST
    • Consultar detalhes do proprietário
      POST
    • Buscar proprietários
      POST
    • Vincular proprietário a imóvel
      POST
  • Cliente
    • Cadastrar cliente
      POST
    • Atualizar cliente
      PUT
    • Cadastrar clientes em lote
      POST
    • Consultar detalhes do cliente
      POST
    • Buscar clientes
      POST
    • Atribuir cliente a corretor
      POST
  • Corretor
    • Consultar corretores
  • Schemas
    • ApiPartnerAuthTokenDTO
    • ApiPartnerAuthTokenResponseDTO
    • ApiPartnerErrorResponseDTO
    • ApiPartnerAuthRefreshTokenDTO
    • ApiPartnerAddressDTO
    • ApiPartnerPropertyDetailDTO
    • ApiPartnerPropertyPriceDTO
    • ApiPartnerPropertyListingDTO
    • ApiPartnerPropertyRegisterDTO
    • ApiPartnerPropertyCreatedDTO
    • ApiPartnerPropertySkippedDTO
    • ApiPartnerPropertyErrorItemDTO
    • ApiPartnerPropertyRegisterResponseDTO
    • ApiPartnerPropertyItemDTO
    • ApiPartnerPropertyBatchRegisterDTO
    • ApiPartnerPropertyUpdateDTO
    • ApiPartnerPropertyUpdateResponseDTO
    • ApiPartnerPropertyFindDTO
    • ApiPartnerListingPriceDTO
    • ApiPartnerListingImageDTO
    • ApiPartnerListingVideoDTO
    • ApiPartnerListingResponseDTO
    • ApiPartnerPropertyDetailResponseDTO
    • ApiPartnerPhotoFileDTO
    • ApiPartnerPhotosInitDTO
    • ApiPartnerPresignedPartDTO
    • ApiPartnerPhotoUploadTargetDTO
    • ApiPartnerPhotosInitResponseDTO
    • ApiPartnerUploadPartDTO
    • ApiPartnerPhotoUploadDTO
    • ApiPartnerPhotosCompleteDTO
    • ApiPartnerPhotoCompleteItemDTO
    • ApiPartnerPhotosCompleteResponseDTO
    • ApiPartnerPhotosStatusDTO
    • ApiPartnerPhotoVariantDTO
    • ApiPartnerPhotoStatusItemDTO
    • ApiPartnerPhotosStatusResponseDTO
    • ApiPartnerDocumentInitDTO
    • ApiPartnerDocumentInitResponseDTO
    • ApiPartnerDocumentCompleteDTO
    • ApiPartnerDocumentCompleteResponseDTO
    • ApiPartnerPropertyFiltroDTO
    • ApiPartnerPropertySearchFiltersDTO
    • ApiPartnerSearchSortDTO
    • ApiPartnerPropertySearchDTO
    • ApiPartnerPropertySummaryDTO
    • ApiPartnerPropertySearchResponseDTO
    • ApiPartnerOwnerSpouseDTO
    • ApiPartnerOwnerRegisterDTO
    • ApiPartnerOwnerCreatedDTO
    • ApiPartnerOwnerSkippedDTO
    • ApiPartnerOwnerErrorItemDTO
    • ApiPartnerOwnerRegisterResponseDTO
    • ApiPartnerOwnerItemDTO
    • ApiPartnerOwnerBatchRegisterDTO
    • ApiPartnerOwnerUpdateDTO
    • ApiPartnerOwnerUpdateResponseDTO
    • ApiPartnerOwnerFindDTO
    • ApiPartnerOwnerSpouseResponseDTO
    • ApiPartnerOwnerDetailResponseDTO
    • ApiPartnerOwnerSearchSortDTO
    • ApiPartnerOwnerSearchFiltersDTO
    • ApiPartnerOwnerSearchDTO
    • ApiPartnerOwnerSummaryDTO
    • ApiPartnerOwnerSearchResponseDTO
    • ApiPartnerOwnerLinkPropertyDTO
    • ApiPartnerOwnerLinkResponseDTO
    • ApiPartnerLeadRegisterDTO
    • ApiPartnerLeadCreatedDTO
    • ApiPartnerLeadSkippedDTO
    • ApiPartnerLeadErrorItemDTO
    • ApiPartnerLeadRegisterResponseDTO
    • ApiPartnerLeadItemDTO
    • ApiPartnerLeadBatchRegisterDTO
    • ApiPartnerLeadUpdateDTO
    • ApiPartnerLeadUpdateResponseDTO
    • ApiPartnerLeadFindDTO
    • ApiPartnerLeadDetailResponseDTO
    • ApiPartnerLeadSearchSortDTO
    • ApiPartnerLeadSearchFiltersDTO
    • ApiPartnerLeadSearchDTO
    • ApiPartnerLeadSummaryDTO
    • ApiPartnerLeadSearchResponseDTO
    • ApiPartnerLeadAssignAgentDTO
    • ApiPartnerLeadAssignAgentResponseDTO
    • ApiPartnerAgentSearchFiltersDTO
    • ApiPartnerAgentSearchDTO
    • ApiPartnerAgentSummaryDTO
    • ApiPartnerAgentSearchResponseDTO
    • ApiPartnerRealtyClusterRegisterDTO
    • ApiPartnerRealtyClusterCreatedDTO
    • ApiPartnerRealtyClusterSkippedDTO
    • ApiPartnerRealtyClusterErrorItemDTO
    • ApiPartnerRealtyClusterRegisterResponseDTO
    • ApiPartnerRealtyClusterItemDTO
    • ApiPartnerRealtyClusterBatchRegisterDTO
    • ApiPartnerRealtyClusterUpdateDTO
    • ApiPartnerRealtyClusterAddressResponseDTO
    • ApiPartnerRealtyClusterDetailResponseDTO
    • ApiPartnerRealtyClusterFindDTO
    • ApiPartnerRealtyClusterLinkPropertiesDTO
    • ApiPartnerRealtyClusterLinkedDTO
    • ApiPartnerRealtyClusterLinkErrorDTO
    • ApiPartnerRealtyClusterLinkResponseDTO
  1. Autenticação

Emitir token

POST
/partner/v1/auth/token
Troca a credencial de parceiro (client_id, client_secret), a chave da imobiliária (api_key) e a lista de scopes por um token. Os QUATRO são obrigatórios — inclusive scopes, que não tem padrão.
O token vale para UMA imobiliária — a dona da api_key. Integrando com várias, emita um token por chave e não os misture: cada rota devolve e grava apenas dados da imobiliária do token.
Peça em scopes só o que for usar. Escopo não concedido à imobiliária derruba a EMISSÃO inteira com 400, e não apenas aquele escopo.
Emita o token uma vez e reaproveite até expirar. Emitir a cada chamada gasta o teto desta rota, que é próprio e mais apertado que o das demais.

Request

Body Params application/jsonRequired

Example
{
    "api_key": "a1b2c3d4e5f6",
    "scopes": [
        "properties",
        "owners"
    ],
    "client_id": "89ed4da8-9700-4c6f-a6f0-9ed7379efcf5",
    "client_secret": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/partner/v1/auth/token' \
--header 'Content-Type: application/json' \
--data '{
    "api_key": "a1b2c3d4e5f6",
    "scopes": [
        "properties",
        "owners"
    ],
    "client_id": "89ed4da8-9700-4c6f-a6f0-9ed7379efcf5",
    "client_secret": "string"
}'

Responses

🟢201
application/json
Token emitido. Use o accessToken em Authorization: Bearer <accessToken>.
Bodyapplication/json

Example
{
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Ii4uLiJ9.4Rw0oS...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Ii4uLiJ9.9KxA1b..."
}
🟠400
🟠429
🔴500
Modified at 2026-08-20 16:06:11
Previous
Bem vindo
Next
Renovar token
Built with