> ## Documentation Index > Fetch the complete documentation index at: https://docs.mlm-platform.com/llms.txt > Use this file to discover all available pages before exploring further. # Capture a lead > Captures a lead with optional referral attribution. Leads can be converted to members later using the member creation endpoint. ## OpenAPI ````yaml api/openapi.yaml post /api/v1/leads/capture openapi: 3.1.0 info: title: MLM Platform API version: 1.0.0 description: > The MLM Platform API enables tenant developers to integrate commission tracking, member management, and referral systems into their applications. ## Authentication All API requests require a tenant API key passed in the `x-tenant-api-key` header. ## Environments - **LIVE**: Production environment with real data - **SANDBOX**: Test environment for development and testing API keys are scoped to specific environments. Use sandbox keys for testing. The environment is derived from the API key used for the request. The platform returns the selected environment in the response header `X-Environment`. If you send an `X-Environment` request header, it is treated as optional/debug-only. contact: name: MLM Platform Support email: support@mlm-platform.example.com license: name: Proprietary url: https://mlm-platform.example.com/terms servers: - url: https://app.mlm-platform.com description: Production API - url: http://localhost:3000 description: Local Development security: - TenantApiKey: [] tags: - name: Auth description: Token exchange, validation, refresh, and revocation for OIDC federation - name: Events description: Purchase and commission events - name: Users description: Member management - name: Leads description: Lead capture and tracking - name: Referrals description: Referral links and codes - name: Payout description: Payout methods metadata for dynamic payout setup forms - name: Payout Accounts description: Member payout accounts (create/list/update/delete) - name: KYC description: Member KYC start, status, and document submission - name: Admin KYC description: Admin KYC review queue, details, and actions - name: Widget description: Embeddable widget authentication - name: Webhooks description: Webhook receivers for third-party providers (Sumsub) paths: /api/v1/leads/capture: post: tags: - Leads summary: Capture a lead description: > Captures a lead with optional referral attribution. Leads can be converted to members later using the member creation endpoint. operationId: captureLead requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CaptureLeadRequest' examples: basic: summary: Basic lead capture value: email: lead@example.com withReferral: summary: Lead with referral value: email: lead@example.com name: John Doe referral_code: ABC123 source: landing_page responses: '201': description: Lead captured successfully content: application/json: schema: $ref: '#/components/schemas/Lead' headers: X-Environment: $ref: '#/components/headers/X-Environment' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '409': description: Conflict - Lead already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: schemas: CaptureLeadRequest: type: object required: - email properties: email: type: string format: email description: Lead email address (normalized to lowercase) name: type: string maxLength: 255 description: Optional display name for the lead phone: type: string description: Optional phone number for the lead referral_code: type: string description: Referral code for attribution source: type: string maxLength: 100 description: Lead source (e.g., "landing_page", "social") utm_source: type: string description: UTM source utm_medium: type: string description: UTM medium utm_campaign: type: string description: UTM campaign Lead: type: object properties: id: type: string format: uuid description: Lead UUID email: type: string format: email description: Lead email address name: type: string nullable: true description: Optional display name referrer_user_id: type: string format: uuid nullable: true description: Referrer MLM user ID, if attribution succeeded conversion_status: type: string description: Lead conversion status created_at: type: string format: date-time description: Lead creation timestamp ErrorResponse: type: object required: - error properties: error: type: string description: Human-readable error message code: type: string description: Machine-readable error code details: type: object additionalProperties: true description: Additional error details headers: X-Environment: description: >- Indicates the environment (LIVE or SANDBOX) the request was processed in (derived from API key) schema: type: string enum: - LIVE - SANDBOX responses: BadRequest: description: Bad Request - Invalid input content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Invalid request body code: VALIDATION_ERROR details: field: email message: Invalid email format Unauthorized: description: Unauthorized - Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_api_key: summary: Missing API key value: error: Authentication required code: UNAUTHORIZED invalid_api_key: summary: Invalid API key value: error: Invalid API key code: INVALID_API_KEY RateLimited: description: Too Many Requests - Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Rate limit exceeded. Try again in 60 seconds. code: RATE_LIMITED headers: Retry-After: description: Seconds until rate limit resets schema: type: integer X-RateLimit-Remaining: description: Remaining requests in the current window schema: type: integer X-RateLimit-Reset: description: Unix timestamp (seconds) when the rate limit window resets schema: type: integer InternalError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: An unexpected error occurred code: INTERNAL_ERROR securitySchemes: TenantApiKey: type: apiKey in: header name: x-tenant-api-key description: > Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard. ````