Skip to main content

Domain Management

The Domain Management submodule handles custom domain configuration, DNS verification, Stripe domain integration, and domain lifecycle operations for account branding and payment processing.

API Endpoints Overview

MethodEndpointDescription
PUT/v1/accounts/domainConfigure custom domain
DELETE/v1/accounts/domainDelete custom domain
DELETE/v1/accounts/domain/pendingDelete pending domain
POST/v1/accounts/domain/processProcess domain verification

MongoDB Collections Used

Primary Collections

  • _accounts - Account records with domain configuration and status
  • account-signup-codes - Domain verification codes and tokens
  • Stripe API - Domain verification for payment processing
  • DNS Services - Domain ownership verification and configuration

Domain Management Workflows

Custom Domain Setup Flow

graph TD
A[Domain Configuration Request] --> B[Validate Domain Format]
B --> C[Check Domain Availability]
C --> D[DNS Ownership Verification]
D --> E[Stripe Domain Verification]
E --> F[Update Account Configuration]
F --> G[Enable Domain Routing]
G --> H[Notify Account Owner]

Domain Verification Process

graph TD
A[Domain Submission] --> B[DNS TXT Record Check]
B --> C[Stripe Verification API]
C --> D{Verification Success?}
D -->|Yes| E[Enable Domain]
D -->|No| F[Retry Verification]
E --> G[Update Account Status]
F --> H[Generate Error Report]
H --> I[Notify User of Issues]

Domain Cleanup Flow

graph TD
A[Domain Deletion Request] --> B[Validate Account Ownership]
B --> C[Disable Stripe Domain]
C --> D[Remove DNS Configuration]
D --> E[Clean Account Records]
E --> F[Update Domain Status]
F --> G[Confirm Deletion]

Service Methods & Functionality

Core Domain Services

domain() - Custom domain configuration

  • Configures custom domains with comprehensive DNS verification
  • Integrates with Stripe for domain verification and payment processing compliance
  • Handles domain format validation and availability checking
  • Manages DNS record verification and ownership confirmation
  • Updates account configuration with new domain settings
  • Returns domain configuration status and verification results

deleteDomain() - Domain removal and cleanup

  • Removes custom domains with proper authorization validation
  • Disables Stripe domain verification and payment processing integration
  • Handles DNS configuration cleanup and record removal
  • Updates account records to remove domain associations
  • Manages domain status transitions and cleanup procedures
  • Returns deletion confirmation and status updates

deletePendingDomain() - Pending domain cleanup

  • Cleans up pending domain configurations that haven't completed verification
  • Removes incomplete domain setup records and temporary configurations
  • Handles cleanup of failed or abandoned domain verification attempts
  • Updates account status to reflect pending domain removal
  • Returns cleanup confirmation and updated account status

processDomain() - Domain verification processing

  • Processes domain verification workflows and status updates
  • Handles batch domain verification and processing operations
  • Manages domain verification retry logic and error handling
  • Updates domain status based on verification results
  • Coordinates with external services for domain validation
  • Returns processing status and verification results

Technical Implementation Details

Domain Verification System

  • DNS Validation: Comprehensive DNS record verification for domain ownership
  • Stripe Integration: Seamless integration with Stripe domain verification API
  • SSL Certificate Management: Automatic SSL certificate provisioning and renewal
  • Domain Routing: Dynamic domain routing configuration for account access

Security & Validation

  • Ownership Verification: Multi-step domain ownership verification process
  • Account Authorization: Owner-only permissions for domain configuration
  • DNS Security: Secure DNS record validation and verification procedures
  • Payment Compliance: Stripe domain verification for PCI compliance

External Service Integration

  • Stripe API: Domain verification for payment processing compliance
  • DNS Services: Integration with DNS providers for record verification
  • SSL Providers: Automatic SSL certificate provisioning and management
  • Domain Registrars: Integration with domain registration and management services

Business Logic Implementation

Domain Configuration Workflow

  1. Domain Format Validation: Validate domain format and structure
  2. Availability Checking: Verify domain availability and ownership
  3. DNS Record Verification: Check DNS TXT records for ownership proof
  4. Stripe Verification: Process Stripe domain verification for payments
  5. Account Configuration: Update account settings with domain information
  6. Routing Setup: Configure domain routing and access permissions
  7. Status Management: Update domain status and notify account owners

Verification Processing Workflow

  1. Batch Processing: Handle multiple domain verifications efficiently
  2. Retry Logic: Implement retry mechanisms for failed verifications
  3. Status Tracking: Monitor verification progress and update statuses
  4. Error Handling: Comprehensive error handling with user notifications
  5. Integration Coordination: Coordinate with external verification services
  6. Result Processing: Process verification results and update configurations

Key Features

Comprehensive Domain Management

  • Custom Domain Support: Full custom domain configuration and management
  • DNS Verification: Robust DNS ownership verification system
  • Stripe Integration: Seamless payment processing domain verification
  • SSL Management: Automatic SSL certificate provisioning and renewal

Advanced Verification System

  • Multi-step Verification: Comprehensive domain ownership verification
  • Batch Processing: Efficient batch domain verification processing
  • Retry Mechanisms: Intelligent retry logic for failed verifications
  • Status Monitoring: Real-time domain verification status tracking

Security & Compliance

  • Ownership Validation: Strict domain ownership verification requirements
  • Payment Compliance: Stripe domain verification for PCI compliance
  • Access Control: Owner-only permissions for domain operations
  • Secure Configuration: Secure domain configuration and management procedures

Integration Capabilities

  • External Services: Integration with DNS providers and domain registrars
  • Payment Processing: Seamless integration with Stripe for payment domains
  • SSL Providers: Automatic SSL certificate management integration
  • Monitoring Systems: Integration with domain monitoring and alerting systems
💬

Documentation Assistant

Ask me anything about the docs

Hi! I'm your documentation assistant. Ask me anything about the docs!

I can help you with:
- Code examples
- Configuration details
- Troubleshooting
- Best practices

Try asking: How do I configure the API?
09:31 AM