Skip to main content
📞 1-888-784-3881🚀 Start Project
🔑API Reference

Authentication

API keys, OAuth flows, and securing your requests.

⏱️ 12 min read

Authentication Methods

PropTechUSA supports two authentication methods:

  • API Keys - For server-to-server communication
  • OAuth 2.0 - For user-facing applications
  • API Key Authentication

    Include your API key in the Authorization header:

    curl https://api.proptechusa.ai/v1/leads \
    

    -H "Authorization: Bearer pk_live_xxxxxxxxxxxxx"

    Or using the SDK:

    const client = new PropTech({
    

    apiKey: 'pk_live_xxxxxxxxxxxxx',

    });

    API Key Types

    TypePrefixUse Case
    Livepk_live_Production environment
    Testpk_test_Development/testing

    Generating API Keys

  • Log in to your PropTechUSA Dashboard
  • Navigate to Settings → API Keys
  • Click "Generate New Key"
  • Copy and securely store your key
  • ⚠️ Important: API keys are shown only once. Store them securely.

    OAuth 2.0 (Coming Soon)

    OAuth 2.0 support is coming soon for applications that need user-level authentication.

    Security Best Practices

    • Never expose API keys in client-side code
    • Use environment variables for all keys
    • Implement IP allowlisting for production
    • Rotate keys if you suspect compromise
    • Use test keys during development