> ## Documentation Index
> Fetch the complete documentation index at: https://docs.authentica.sa/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Current Balance

> This endpoint retrieves your current account balance.

The balance is displayed in credits, which are used to pay for SMS, WhatsApp, Email, and other verification services.




## OpenAPI

````yaml get /balance
openapi: 3.1.0
info:
  title: Authentica API Documentation
  version: 2.0.0
  description: >
    Authentica provides secure and flexible customer authentication through
    **OTP verification** via **SMS**, **WhatsApp**, and **Email**.

    It also supports **Face** and **Voice** verification for enhanced identity
    assurance.


    You can easily integrate with our system using RESTful APIs and manage your
    authentication process through multiple secure and customizable channels.


    Our system provides many templates to send OTP messages via SMS channel
    using Authentica default sender name.


    Our APIs are designed for easy integration, offering clear endpoints to help
    you implement robust authentication solutions in your applications.


    ## Getting Started


    1. Sign up for an Authentica account at
    [https://portal.authentica.sa](https://portal.authentica.sa)

    2. [Get Your API Key](https://portal.authentica.sa/applications/)

    3. Use your API key in the `X-Authorization` header for all requests


    ## Workflows


    ### OTP Verification Workflow


    1. **Send OTP** - Use the `/send-otp` endpoint to send an OTP via SMS,
    WhatsApp, or Email

    2. **Verify OTP** - Use the `/verify-otp` endpoint to validate the OTP
    entered by your customer


    ### Face Verification Workflow


    Use the `/verify-by-face` endpoint to compare two images: a reference image
    and a real-time image captured by your application.


    ### Voice Verification Workflow


    Use the `/verify-by-voice` endpoint to compare two audio samples: a
    reference audio and a real-time audio recorded by your application.
  contact:
    name: Authentica Support
    url: https://wa.me/966536553944
servers:
  - url: https://api.authentica.sa/api/v2
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Balance Monitoring
    description: Monitor your account balance and credits
  - name: OTP Verification
    description: Send and verify one-time passwords via SMS, WhatsApp, or Email
  - name: Face Verification
    description: Verify users through facial recognition
  - name: Voice Verification
    description: Verify users through voice biometrics
paths:
  /balance:
    get:
      tags:
        - Balance Monitoring
      summary: Get Current Balance
      description: >
        This endpoint retrieves your current account balance.


        The balance is displayed in credits, which are used to pay for SMS,
        WhatsApp, Email, and other verification services.
      operationId: getBalance
      responses:
        '200':
          description: Balance retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      balance:
                        type: number
                        example: 21934
                        description: Current account balance in credits
                  message:
                    type: string
                    example: Balance retrieved successfully
              examples:
                success:
                  summary: Successful balance retrieval
                  value:
                    success: true
                    data:
                      balance: 21934
                    message: Balance retrieved successfully
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  summary: Unauthorized error
                  value:
                    errors:
                      - message: Unauthorized
components:
  schemas:
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                example: Unauthorized
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Authorization
      description: >
        API key for authentication. [Get Your API
        Key](https://portal.authentica.sa/applications/)

````