{"openapi":"3.1.0","info":{"title":"Unified Building Pro — Public Property Reports API","version":"1.0.0","summary":"NYC property data on demand for humans and AI agents.","description":"Free building profile for any NYC address/BBL; paid report sections (OWNERSHIP $5.00, OWNER_ENTITY $5.00, VIOLATIONS_COMPLIANCE $5.00, DEVELOPMENT_RIGHTS $5.00, SALES_COMPARISON $5.00) or FULL $19.00. Pay by Stripe Checkout or prepaid API-key credits. Unauthenticated report requests return 402 with payment options. This report is compiled from public records published by the City and State of New York and is provided for informational purposes only. It is not a title search, zoning opinion, appraisal, or legal advice. Records may be incomplete, delayed, or contain errors at the source. Verify with the issuing agency before relying on any item. Not a consumer report: do not use it to decide on tenancy, employment, credit, or insurance eligibility (Fair Credit Reporting Act).","termsOfService":"https://www.unifiedbuildingpro.com/terms","contact":{"email":"admin@unifiedbuildingpro.com","url":"https://www.unifiedbuildingpro.com"},"x-llms-txt":"https://www.unifiedbuildingpro.com/llms.txt"},"servers":[{"url":"https://www.unifiedbuildingpro.com/api/public","description":"Always use the www host. Requests to the apex host are redirected with 308 (method and body preserved)."}],"tags":[{"name":"Property"},{"name":"Reports"},{"name":"API Keys"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"ubp_live_...","description":"Create with POST /api-keys. Prepaid credits are debited per report."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}},"Identity":{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"bin":{"type":"string"},"borough":{"type":"string"},"boroughKey":{"type":"string"},"block":{"type":"string"},"lot":{"type":"string"},"address":{"type":"string"},"zipCode":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["bbl","borough","block","lot"]},"Selection":{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"address":{"type":"string"},"borough":{"type":"string"},"products":{"type":"array","minItems":1,"items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}}},"required":["products"],"description":"Provide bbl or address (+ optional borough)."},"OrderView":{"type":"object","properties":{"id":{"type":"string"},"accessToken":{"type":"string"},"status":{"type":"string","enum":["PENDING_PAYMENT","PAID","FULFILLING","FULFILLED","FAILED","REFUNDED","EXPIRED"]},"source":{"type":"string","enum":["CHECKOUT","API_KEY"]},"bbl":{"type":"string"},"addressLabel":{"type":"string"},"products":{"type":"array","items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}},"amountCents":{"type":"integer"},"amount":{"type":"string"},"currency":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"paidAt":{"type":["string","null"]},"fulfilledAt":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"isExpired":{"type":"boolean"},"report":{"type":["object","null"],"description":"PropertyReport JSON when FULFILLED","additionalProperties":true},"pdfUrl":{"type":["string","null"]},"jsonUrl":{"type":["string","null"]},"availableAddons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"priceCents":{"type":"integer"},"price":{"type":"string"},"tagline":{"type":"string"}}}},"error":{"type":["string","null"]}}}}},"paths":{"/property/preview":{"get":{"tags":["Property"],"summary":"Free building profile","operationId":"getPropertyPreview","parameters":[{"name":"address","in":"query","schema":{"type":"string"},"example":"247 Bowery"},{"name":"borough","in":"query","schema":{"type":"string"},"example":"Manhattan"},{"name":"bbl","in":"query","schema":{"type":"string","pattern":"^\\d{10}$"}}],"responses":{"200":{"description":"ok or ambiguous","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok","ambiguous"]},"identity":{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"bin":{"type":"string"},"borough":{"type":"string"},"boroughKey":{"type":"string"},"block":{"type":"string"},"lot":{"type":"string"},"address":{"type":"string"},"zipCode":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["bbl","borough","block","lot"]},"profile":{"type":"object","additionalProperties":true},"signals":{"type":"object","additionalProperties":true},"products":{"type":"array","items":{"type":"object","additionalProperties":true}},"candidates":{"type":"array","items":{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"bin":{"type":"string"},"borough":{"type":"string"},"boroughKey":{"type":"string"},"block":{"type":"string"},"lot":{"type":"string"},"address":{"type":"string"},"zipCode":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["bbl","borough","block","lot"]}},"how_to_buy":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"404":{"description":"No match","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/property-reports/products":{"get":{"tags":["Reports"],"summary":"Catalog, prices, credit packs, how to buy","operationId":"listReportProducts","responses":{"200":{"description":"Catalog","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/property-reports/quote":{"post":{"tags":["Reports"],"summary":"Price a selection (no charge)","operationId":"quoteReport","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"address":{"type":"string"},"borough":{"type":"string"},"products":{"type":"array","minItems":1,"items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}}},"required":["products"],"description":"Provide bbl or address (+ optional borough)."}}}},"responses":{"200":{"description":"Quote","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"404":{"description":"No match","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/property-reports/orders":{"post":{"tags":["Reports"],"summary":"Create an order and get a Stripe Checkout URL","operationId":"createReportOrder","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"address":{"type":"string"},"borough":{"type":"string"},"products":{"type":"array","minItems":1,"items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}}},"required":["products"],"description":"Provide bbl or address (+ optional borough)."},{"type":"object","properties":{"email":{"type":"string","format":"email"},"success_url":{"type":"string","format":"uri"},"cancel_url":{"type":"string","format":"uri"}},"required":["email"]}]}}}},"responses":{"201":{"description":"Pending payment","content":{"application/json":{"schema":{"type":"object","properties":{"order_token":{"type":"string"},"checkout_url":{"type":"string"},"order_url":{"type":"string"},"view_url":{"type":"string"},"amount_cents":{"type":"integer"}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"404":{"description":"No match","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"409":{"description":"Ambiguous address","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"503":{"description":"Payments unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/property-reports/orders/{token}":{"get":{"tags":["Reports"],"summary":"Order status and report","operationId":"getReportOrder","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","schema":{"type":"string","enum":["json","pdf"]}}],"responses":{"200":{"description":"Order","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"accessToken":{"type":"string"},"status":{"type":"string","enum":["PENDING_PAYMENT","PAID","FULFILLING","FULFILLED","FAILED","REFUNDED","EXPIRED"]},"source":{"type":"string","enum":["CHECKOUT","API_KEY"]},"bbl":{"type":"string"},"addressLabel":{"type":"string"},"products":{"type":"array","items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}},"amountCents":{"type":"integer"},"amount":{"type":"string"},"currency":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"paidAt":{"type":["string","null"]},"fulfilledAt":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"isExpired":{"type":"boolean"},"report":{"type":["object","null"],"description":"PropertyReport JSON when FULFILLED","additionalProperties":true},"pdfUrl":{"type":["string","null"]},"jsonUrl":{"type":["string","null"]},"availableAddons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"priceCents":{"type":"integer"},"price":{"type":"string"},"tagline":{"type":"string"}}}},"error":{"type":["string","null"]}}}}}},"302":{"description":"Redirect to PDF when format=pdf"},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/property-reports":{"post":{"tags":["Reports"],"summary":"Buy a report synchronously with API-key credits","operationId":"createReportWithApiKey","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bbl":{"type":"string","pattern":"^\\d{10}$"},"address":{"type":"string"},"borough":{"type":"string"},"products":{"type":"array","minItems":1,"items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}}},"required":["products"],"description":"Provide bbl or address (+ optional borough)."}}}},"responses":{"201":{"description":"Fulfilled report","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string"},"accessToken":{"type":"string"},"status":{"type":"string","enum":["PENDING_PAYMENT","PAID","FULFILLING","FULFILLED","FAILED","REFUNDED","EXPIRED"]},"source":{"type":"string","enum":["CHECKOUT","API_KEY"]},"bbl":{"type":"string"},"addressLabel":{"type":"string"},"products":{"type":"array","items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}},"amountCents":{"type":"integer"},"amount":{"type":"string"},"currency":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"paidAt":{"type":["string","null"]},"fulfilledAt":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"isExpired":{"type":"boolean"},"report":{"type":["object","null"],"description":"PropertyReport JSON when FULFILLED","additionalProperties":true},"pdfUrl":{"type":["string","null"]},"jsonUrl":{"type":["string","null"]},"availableAddons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"priceCents":{"type":"integer"},"price":{"type":"string"},"tagline":{"type":"string"}}}},"error":{"type":["string","null"]}}},{"type":"object","properties":{"credits_remaining_cents":{"type":"integer"}}}]}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"401":{"description":"unauthorized — missing or invalid API key","headers":{"WWW-Authenticate":{"schema":{"type":"string"},"description":"Bearer realm=\"unifiedbuildingpro-public-api\""}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"402":{"description":"payment_required (no key; carries a WWW-Authenticate: Bearer challenge) or insufficient_credits (valid key, low balance; body has topup)","headers":{"WWW-Authenticate":{"schema":{"type":"string"},"description":"Present on payment_required only"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"No match","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"409":{"description":"Ambiguous address","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"503":{"description":"upstream_unavailable — NYC/NYS data sources down; credits were not charged (or were refunded). Retry later. Repeating the same key+bbl+products within 10 minutes returns the existing order rather than charging again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys":{"post":{"tags":["API Keys"],"summary":"Create an API key with the emailed code (shown once)","operationId":"createApiKey","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"code":{"type":"string","pattern":"^\\d{6}$"},"label":{"type":"string"}},"required":["email","code"]}}}},"responses":{"201":{"description":"Key created","content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string"},"key_id":{"type":"string"},"credits_cents":{"type":"integer"},"next":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys/start":{"post":{"tags":["API Keys"],"summary":"Email a 6-digit code before a key is made","operationId":"startApiKey","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"}},"required":["email"]}}}},"responses":{"200":{"description":"Code sent","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean"},"sent_to":{"type":"string"}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"too_many_codes","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys/verify-email/send":{"post":{"tags":["API Keys"],"summary":"Email a 6-digit code to the address on the key","operationId":"sendApiKeyEmailCode","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Code sent (or already verified)","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean"},"sent_to":{"type":"string"},"email_verified":{"type":"boolean"}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"401":{"description":"unauthorized — missing or invalid API key","headers":{"WWW-Authenticate":{"schema":{"type":"string"},"description":"Bearer realm=\"unifiedbuildingpro-public-api\""}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"too_many_codes","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys/verify-email":{"post":{"tags":["API Keys"],"summary":"Confirm the email with the 6-digit code (needed before credits or reports)","operationId":"verifyApiKeyEmail","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"responses":{"200":{"description":"Verified","content":{"application/json":{"schema":{"type":"object","properties":{"email_verified":{"type":"boolean"}}}}}},"400":{"description":"code_not_accepted","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"401":{"description":"unauthorized — missing or invalid API key","headers":{"WWW-Authenticate":{"schema":{"type":"string"},"description":"Bearer realm=\"unifiedbuildingpro-public-api\""}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys/me":{"get":{"tags":["API Keys"],"summary":"Balance and recent ledger","operationId":"getApiKey","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Summary","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys/me/orders":{"get":{"tags":["API Keys"],"summary":"Reports bought with this key","operationId":"listApiKeyOrders","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Orders","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"accessToken":{"type":"string"},"status":{"type":"string","enum":["PENDING_PAYMENT","PAID","FULFILLING","FULFILLED","FAILED","REFUNDED","EXPIRED"]},"source":{"type":"string","enum":["CHECKOUT","API_KEY"]},"bbl":{"type":"string"},"addressLabel":{"type":"string"},"products":{"type":"array","items":{"type":"string","enum":["FULL","OWNERSHIP","OWNER_ENTITY","VIOLATIONS_COMPLIANCE","DEVELOPMENT_RIGHTS","SALES_COMPARISON"]}},"amountCents":{"type":"integer"},"amount":{"type":"string"},"currency":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"paidAt":{"type":["string","null"]},"fulfilledAt":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"isExpired":{"type":"boolean"},"report":{"type":["object","null"],"description":"PropertyReport JSON when FULFILLED","additionalProperties":true},"pdfUrl":{"type":["string","null"]},"jsonUrl":{"type":["string","null"]},"availableAddons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"priceCents":{"type":"integer"},"price":{"type":"string"},"tagline":{"type":"string"}}}},"error":{"type":["string","null"]}}}}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"401":{"description":"unauthorized — missing or invalid API key","headers":{"WWW-Authenticate":{"schema":{"type":"string"},"description":"Bearer realm=\"unifiedbuildingpro-public-api\""}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}},"/api-keys/credits/checkout":{"post":{"tags":["API Keys"],"summary":"Stripe Checkout URL to add credits","operationId":"createCreditsCheckout","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pack":{"type":"string","enum":["CREDITS_20","CREDITS_50","CREDITS_100"]},"success_url":{"type":"string"},"cancel_url":{"type":"string"}},"required":["pack"]}}}},"responses":{"201":{"description":"Checkout","content":{"application/json":{"schema":{"type":"object","properties":{"checkout_url":{"type":"string"},"amount_cents":{"type":"integer"}}}}}},"400":{"description":"bad_request — validation failed or the body is not valid JSON","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"401":{"description":"unauthorized — missing or invalid API key","headers":{"WWW-Authenticate":{"schema":{"type":"string"},"description":"Bearer realm=\"unifiedbuildingpro-public-api\""}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"413":{"description":"payload_too_large — bodies over 32 kB","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"429":{"description":"rate_limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"500":{"description":"internal_error (message carries a reference id)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}},"503":{"description":"payments_unavailable — Stripe not configured","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}}}}