Preview property setup or a manual observation. Does not affect net worth until apply. Automatic mode retrieves two paid provider endpoints within the configured quota.

Manage tracked property evidence through the reviewed preview and apply flow.

post/v1/properties/preview

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/properties/preview
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

property_idstring

Existing property to update; omit to create a property. Use its canonical id to prevent duplicate assets.

namestring required

User-facing name, such as Home or Oak Street rental.

property_type'Single Family' | 'Condo' | 'Townhouse' | 'Manufactured' | 'Multi-Family' | 'Apartment' | 'Other' required

Physical property type. Multi-family automatic rent is per unit and never summed as the building's rent.

ownership_percentnumber required

Owned share, from greater than zero through 100 percent. Value and whole-property rent contributions use this share. Mortgage balances remain as recorded in the linked account.

debt_freeboolean required

True only when the property is known to have no secured debt. False with no linked mortgage leaves equity unknown.

mortgage_source_account_idstring

Visible loan account already in this workspace. Linking it does not add another liability. One loan can be linked to one property.

mortgage_balance_scope'full_account'

Explicit confirmation that the entire linked loan balance belongs in this property equity calculation. Omit when joint debt responsibility is unresolved; equity remains unknown. Never infer from ownership_percent. Net worth continues to count the account balance once.

estimate_providerstring

Automated estimate provider identifier. Currently rentcast; omitted uses the existing connection or RentCast for a new connection. Stored with the provider property ID to namespace external identities.

tracking_mode'automatic' | 'manual' required

Automatic connects monthly US estimates. Manual pins imported or entered observations and prevents automatic replacement.

as_ofstring date

Date of the manual observation, required in manual mode. Must not be in the future. Omit for automatic mode.

source_labelstring

Name of the appraisal, statement, or source behind the manual observation.

source_locatorstring

Optional evidence URI or document reference; retained as provenance, never fetched automatically.

Response

Property operation result.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.