1. Proprietário
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. Proprietário

Consultar detalhes do proprietário

POST
/partner/v1/property-owner/find
Qualificação completa pelo partner_code: contato, documento, endereço e cônjuge. É POST, e não GET com o código no caminho, porque o código é do sistema do parceiro e pode conter barra, espaço ou acento.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Example
{
    "partner_code": "PROP-4471"
}

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/property-owner/find' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "partner_code": "PROP-4471"
}'

Responses

🟢200
application/json
Detalhe do proprietário.
Bodyapplication/json

Example
{
    "partner_code": "AP-1024",
    "property_owner_id": "66c1f3a2e4b0a1d2c3e4f5a6",
    "name": "Ana Corretora",
    "whatsapp": "48999998888",
    "email": "ana@imobiliaria.com.br",
    "birth_date": "1985-03-14",
    "created_at": "2026-08-19T20:33:39.719Z",
    "updated_at": "2026-08-19T20:33:39.719Z",
    "is_active": true,
    "phone": "string",
    "document": "string",
    "document_type": "string",
    "notes": "string",
    "address_state": "string",
    "address_city": "string",
    "address_zipcode": "string",
    "address_street": "string",
    "address_number": "string",
    "address_complement": "string",
    "address_neighborhood": "string",
    "profession": "string",
    "marital_status": "string",
    "marriage_regime": "string",
    "nationality": "string",
    "rg": "string",
    "rg_issuer": "string",
    "origin": "string",
    "spouse": {
        "name": "Ana Corretora",
        "email": "ana@imobiliaria.com.br",
        "birth_date": "1985-03-14",
        "document": "string",
        "rg": "string",
        "profession": "string",
        "nationality": "string"
    }
}
🟠400
🟠401
🟠403
🟠404
🟠429
🔴500
Modified at 2026-08-20 16:06:11
Previous
Cadastrar proprietários em lote
Next
Buscar proprietários
Built with