# Get Current Balance Source: https://authentica.mintlify.app/api-reference/balance-monitoring/get-current-balance get /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. # Verify By Face Source: https://authentica.mintlify.app/api-reference/face-verification/verify-by-face post /verify-by-face Verify whether the reference image and the real-time image match. This endpoint compares two face images: - `registered_face_image`: Reference image - `query_face_image`: Real-time image captured by your application # Send OTP Source: https://authentica.mintlify.app/api-reference/otp-verification/send-otp post /send-otp Send an OTP (One-Time Password) to a user's mobile number or email address. **Features:** - SMS delivery via your own sender name or Authentica's default sender - Email delivery via your own email or Authentica's default email - Multiple templates available **Note:** Check Application settings on Authentica dashboard to set default values for OTP options. # Verify OTP Source: https://authentica.mintlify.app/api-reference/otp-verification/verify-otp post /verify-otp Verify the OTP entered by your customer for authentication. This endpoint validates the OTP against the one sent via `/send-otp` endpoint. # Verify By Voice Source: https://authentica.mintlify.app/api-reference/voice-verification/verify-by-voice post /verify-by-voice Verify whether the reference audio and the real-time audio match. This endpoint compares two voice samples: - `registered_audio`: Reference audio - `query_audio`: Real-time audio recorded by your application # Face Verification Workflow Source: https://authentica.mintlify.app/guides/face-verification-workflow Implement biometric face verification # Face Verification Workflow Use the `/verify-by-face` endpoint to compare two face images: a reference image and a real-time image captured by your application. Authentica analyzes both images and determines whether they match. ## How It Works 1. Provide a `registered_face_image` (reference image) 2. Provide a `query_face_image` (real-time image from your app) 3. Authentica compares them and returns the match result See the [Verify by Face API Reference](/api-reference/face-verification/verify-by-face) for detailed parameter documentation. # OTP Verification Workflow Source: https://authentica.mintlify.app/guides/otp-workflow Send and verify one-time passwords # OTP Verification Workflow To implement OTP verification, follow these steps: ## 1. Send OTP Use the `/send-otp` endpoint to send an OTP via SMS, WhatsApp, or Email. Supports: * Custom OTPs * SMS delivery via your own sender name registered with Authentica or default sender name offered by Authentica * Email delivery via your own email address registered with Authentica or default email address offered by Authentica * Control fallback channel, templates with ids 1 and 2 will be used for the fallback OTP based on the language of the main template you used in the request **Note:** Check Application setting on Authentica dashboard to set default values for OTP options. ### Example Request ```bash theme={null} curl --location 'api.authentica.sa/api/v2/send-otp' \ --header 'Accept: application/json' \ --header 'X-Authorization: $2y$10$XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \ --header 'Content-Type: application/json' \ --data '{ "method":"sms", "phone":"+9665XXXXXXXXX", "template_id":31, "fallback_email":"email@test.test", "otp":"123456" }' ``` ## 2. Verify OTP Use the Verify OTP endpoint to validate the OTP entered by your customer. ### Example Request ```bash theme={null} curl --location 'api.authentica.sa/api/v2/verify-otp' \ --header 'X-Authorization: $XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "phone":"+9665XXXXXXXX", "email":"email@test.test", "otp":"OTP-ENTERED-BY-THE-USER" }' ``` See the [API Reference](/api-reference/otp-verification/send-otp) for detailed parameter documentation. # Voice Verification Workflow Source: https://authentica.mintlify.app/guides/voice-verification-workflow Implement voice biometric verification # 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. Authentica analyzes both samples and determines if they match. ## How It Works 1. Provide a `registered_audio` (reference audio) 2. Provide a `query_audio` (real-time audio from your app) 3. Authentica compares them and returns the match result See the [Verify by Voice API Reference](/api-reference/voice-verification/verify-by-voice) for detailed parameter documentation. # Welcome to Authentica Source: https://authentica.mintlify.app/introduction/welcome Secure and flexible customer authentication through multiple verification channels # Authentica API Documentation 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. This manual is for developers integrating with Authentica. ## Quick Links Access your Authentica dashboard Explore complete API documentation Get help from our support team ## Getting Started Create your Authentica account Generate your authentication key Integrate with your application ## Authentication All API requests require authentication using an API key in the `X-Authorization` header. Generate your API key from your Authentica account at [portal.authentica.sa/applications/create](https://portal.authentica.sa/applications/create) ### Quick Example ```bash cURL theme={null} curl --location 'https://api.authentica.sa/api/v2/balance' \ --header 'X-Authorization: YOUR_API_KEY' \ --header 'Accept: application/json' ``` ```javascript JavaScript theme={null} const response = await fetch('https://api.authentica.sa/api/v2/balance', { headers: { 'X-Authorization': 'YOUR_API_KEY', 'Accept': 'application/json' } }); const data = await response.json(); console.log(data); ``` ```python Python theme={null} import requests response = requests.get( 'https://api.authentica.sa/api/v2/balance', headers={ 'X-Authorization': 'YOUR_API_KEY', 'Accept': 'application/json' } ) print(response.json()) ``` ## Key Features SMS, WhatsApp, and Email Simple RESTful APIs Industry-standard security ## Workflows Explore our authentication workflows: Send and verify one-time passwords via SMS, WhatsApp, or Email Implement biometric face verification Implement voice biometric verification ## Support Need help? Contact [Authentica support team](https://wa.me/966536553944)