Skip to documentation
SparkGlimDeveloper
AI integration hub
SparkGlimSparkGlim Developer
Search all documentation

Try a topic in your language or an exact API path.

    Documentation navigation

    API reference

    Request configured OTP

    Starts an account-scoped verification challenge using an enabled delivery channel and records its expiry and delivery state.

    POSThttps://api.sparkglim.net/api/white-label/portal/reseller/otp/send

    Access model

    Access model
    SparkGlim session and member permissions
    Required scope
    otp:send
    Documented availability
    Implemented in source

    Availability is verified from source, not a live production guarantee.

    Use the creator-team member workflow. Reseller access never grants unrestricted database or administrator access.

    Headers

    NameTypeValidation
    AuthorizationRequired

    Existing SparkGlim bearer session; server account membership and assigned capabilities still authorize each operation.

    		stringValidation: Bearer existing authenticated session token.

    Request

    NameTypeValidation
    channelRequired

    Delivery or integration channel supported by this operation and the account’s enabled configuration.

    		enumValidation: sms | email | whatsapp.
    recipientRequired

    Destination contact for the requested permitted notification or verification challenge.

    		stringValidation: 3–255.
    purposeRequired

    Supported verification purpose, bound to the requesting account and OTP challenge.

    		enumValidation: login | signup | withdrawal_approval | payment_method_verification | campaign_approval.
    memberIdOptional

    Existing account-scoped relationship or review record; ownership and required capabilities are checked on the server.

    		string|nullValidation: UUID.
    metadataOptional

    Additional JSON metadata accepted by the documented schema; it never overrides authorization, prices or account ownership.

    		objectValidation: JSON object.

    Request

    Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

    POST /api/white-label/portal/reseller/otp/send
    http
    POST /api/white-label/portal/reseller/otp/send HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "channel": "email",
  "recipient": "member@example.com",
  "purpose": "login"
}

    Response

    Success response · HTTP 201
    json
    {
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "expiresAt": "2030-01-01T00:10:00.000Z",
    "source": "sms_verification_codes"
  }
}
    Error response · HTTP 400
    json
    {
  "success": false,
  "error": "<ERROR_MESSAGE>"
}

    Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

    Limits & retries

    Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

    Source compatibility

    Authorized operations require account-specific testing.

    • server/src/api/router.ts
    • server/src/api/routes/white-label.ts
    • server/src/white-label/reseller-service.ts
    • server/src/white-label/schemas.ts

    Continue building