---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Send an OTP to a customer

Sends an OTP via SMS or email to the supplied phone number, email address, or identity. Accepts phone numbers in any common format. No JWT is required, but a Google reCAPTCHA token must be provided in the request header.

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "EclipseNotificationType": {
        "type": "string",
        "enum": [
          "EMAIL",
          "PUSH",
          "SMS",
          "TEMPLATE"
        ]
      },
      "EclipseVerification": {
        "type": "object",
        "properties": {
          "customerId": {
            "type": "integer",
            "format": "int64",
            "description": "Customer Id to lookup customer phone number and/or email"
          },
          "email": {
            "type": "string",
            "description": "Customer email number where the email link will be sent"
          },
          "identity": {
            "type": "string",
            "description": "Customer identity where the OTP will be sent. Eclipse will look up the customers phone number or email based on the identity passed to send otp. "
          },
          "phone": {
            "type": "string",
            "description": "Customer phone number where the OTP will be sent"
          },
          "templateId": {
            "type": "string",
            "description": "Mustache template Id for verification. The eclipse will look templateId in the property if templateId is found then it will send Email else return an error. "
          },
          "tenantId": {
            "type": "integer",
            "format": "int64",
            "description": "Optional. The tenants id if known so that tenant specific messaging can be done"
          },
          "type": {
            "$ref": "#/components/schemas/EclipseNotificationType",
            "description": "Verification type. Defaults to SMS if not provided",
            "type": "string"
          }
        }
      },
      "ExceptionData": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "environment": {
            "type": "string"
          },
          "info": {
            "type": "object",
            "additionalProperties": {}
          },
          "severity": {
            "$ref": "#/components/schemas/ExceptionSeverity"
          },
          "spanId": {
            "type": "string"
          },
          "stackTrace": {
            "type": "string"
          },
          "traceId": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/ExceptionType"
          }
        }
      },
      "ExceptionSeverity": {
        "type": "string",
        "enum": [
          "CRITICAL",
          "HIGH",
          "INFO",
          "LOW",
          "MEDIUM"
        ]
      },
      "ExceptionType": {
        "type": "string",
        "enum": [
          "BUSINESS",
          "SYSTEM"
        ]
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "z) Global Functionality",
      "description": "For internal use only. Functionality that is not specific to a tenant"
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/global/verifications": {
      "post": {
        "summary": "Send an OTP to a customer",
        "description": "Sends an OTP via SMS or email to the supplied phone number, email address, or identity. Accepts phone numbers in any common format. No JWT is required, but a Google reCAPTCHA token must be provided in the request header.",
        "tags": [
          "z) Global Functionality"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EclipseVerification"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Bad Request"
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ],
        "parameters": []
      }
    }
  }
}
```