openapi: 3.0.3 info: title: 'VerifiedGlobalSms API Documentation' description: 'Welcome to VerifiedGlobalSms API Documentation. This API is designed to help you get started with using VerifiedGlobalSms services.' version: 1.0.0 servers: - url: 'https://verifiedglobalsms.com' tags: - name: 'User API' description: "\nAPIs for managing SMS activations programmatically." components: securitySchemes: default: type: http scheme: bearer description: "

This API uses API key authentication.

\n

Include your API key in the Authorization header when making requests.

\n

To obtain an API key:

\n
    \n
  1. Log in to your account on our website.
    2. \n
  2. Navigate to your user profile or dashboard.
    3. \n
  3. Copy the API key provided there.
    4. \n
  4. Use this key in all authenticated requests.
    5. \n
\n

For example:
\nAuthorization: Bearer your-api-key-here

\n

You do not need to register or log in through this API. Each user manages their own authentication on their platform; our API only requires the API key for access.

\n" security: - default: [] paths: /api/v1/user/balance: get: summary: 'Get Balance' operationId: getBalance description: 'Returns the current wallet balance of the user in Naira (₦).' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success balance: 5000.0 currency: NGN properties: status: type: string example: success balance: type: number example: 5000.0 currency: type: string example: NGN tags: - 'User API' /api/v1/activations/countries: get: summary: 'List Countries' operationId: listCountries description: 'Returns a list of all enabled countries and their codes.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success countries: nigeria: Nigeria ghana: Ghana usa: USA properties: status: type: string example: success countries: type: object properties: nigeria: type: string example: Nigeria ghana: type: string example: Ghana usa: type: string example: USA tags: - 'User API' /api/v1/activations/services: get: summary: 'List Services' operationId: listServices description: 'Returns available services. If country is provided, it returns services available in that specific country with Naira prices.' parameters: - in: query name: country description: "The country code (e.g., 'nigeria')." example: nigeria required: false schema: type: string description: "The country code (e.g., 'nigeria')." example: nigeria responses: 200: description: '' content: application/json: schema: type: object example: status: success services: whatsapp: name: WhatsApp price: 250.0 currency: NGN facebook: name: Facebook price: 180.0 currency: NGN properties: status: type: string example: success services: type: object properties: whatsapp: type: object properties: name: type: string example: WhatsApp price: type: number example: 250.0 currency: type: string example: NGN facebook: type: object properties: name: type: string example: Facebook price: type: number example: 180.0 currency: type: string example: NGN tags: - 'User API' /api/v1/activations/prices: get: summary: 'Get Prices' operationId: getPrices description: 'Get prices for a country or a specific service in a country in Naira (₦).' parameters: - in: query name: country description: 'The country code.' example: nigeria required: true schema: type: string description: 'The country code.' example: nigeria - in: query name: service description: 'The service code.' example: google required: false schema: type: string description: 'The service code.' example: google responses: 200: description: '' content: application/json: schema: oneOf: - description: '' type: object example: status: success price: 350.0 currency: NGN properties: status: type: string example: success price: type: number example: 350.0 currency: type: string example: NGN - description: '' type: object example: status: success prices: whatsapp: 250.0 facebook: 180.0 currency: NGN properties: status: type: string example: success prices: type: object properties: whatsapp: type: number example: 250.0 facebook: type: number example: 180.0 currency: type: string example: NGN tags: - 'User API' security: [] /api/v1/activations/purchase: post: summary: 'Purchase Number' operationId: purchaseNumber description: 'Requests a new phone number for a specific service and country.' parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: status: success message: 'Number purchased successfully' activation: id: 123 phone_number: '+2348012345678' service: google country: nigeria cost: 350.0 status: active expires_at: '2024-02-07T19:20:46Z' properties: status: type: string example: success message: type: string example: 'Number purchased successfully' activation: type: object properties: id: type: integer example: 123 phone_number: type: string example: '+2348012345678' service: type: string example: google country: type: string example: nigeria cost: type: number example: 350.0 status: type: string example: active expires_at: type: string example: '2024-02-07T19:20:46Z' 400: description: '' content: application/json: schema: type: object example: status: error message: 'Insufficient balance. Required: N350.00' properties: status: type: string example: error message: type: string example: 'Insufficient balance. Required: N350.00' tags: - 'User API' requestBody: required: true content: application/json: schema: type: object properties: service: type: string description: "The service code (e.g., 'google')." example: google country: type: string description: "The country code (e.g., 'nigeria')." example: nigeria required: - service - country '/api/v1/activations/{id}': get: summary: 'Get Activation Status' operationId: getActivationStatus description: 'Retrieves the current status of an activation, including the SMS code if received.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success activation: id: 123 status: completed sms_code: '123456' phone_number: '+2348012345678' expires_at: '2024-02-07T19:20:46Z' updated_at: '2024-02-07 19:15:46' properties: status: type: string example: success activation: type: object properties: id: type: integer example: 123 status: type: string example: completed sms_code: type: string example: '123456' phone_number: type: string example: '+2348012345678' expires_at: type: string example: '2024-02-07T19:20:46Z' updated_at: type: string example: '2024-02-07 19:15:46' tags: - 'User API' parameters: - in: path name: id description: 'The activation ID.' example: 123 required: true schema: type: integer '/api/v1/activations/{id}/cancel': post: summary: 'Cancel Activation' operationId: cancelActivation description: "Cancels a pending activation and refunds the cost to the user's wallet." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Activation cancelled successfully' new_balance: 5350.0 properties: status: type: string example: success message: type: string example: 'Activation cancelled successfully' new_balance: type: number example: 5350.0 tags: - 'User API' parameters: - in: path name: id description: 'The activation ID.' example: 123 required: true schema: type: integer