Skip to main content
Version: 1.0

Application Management

Use your application server key to read application settings, check wallet balance, and create a wallet top-up payment URL from your backend.

These endpoints are backend-to-backend (same auth style as Verification REST endpoints).

Overview​

Base URLhttps://api.verifyspeed.com
Authserver-key header (application server key from the dashboard)
Content-Typeapplication/json
JSONcamelCase; enums as strings
Rate limitingSame server-key rate limit policy as verification endpoints

Copy your server key from the VerifySpeed dashboard under application settings / keys. Never expose the server key in mobile or browser clients.


Get Application Info​

Returns public application details for the application identified by your server key.

Endpoint: GET https://api.verifyspeed.com/v1/applications/info

Request Headers​

  • server-key (required): Server key obtained from the dashboard. Missing or invalid key → unauthorized.
curl -X GET "https://api.verifyspeed.com/v1/applications/info" \
-H "server-key: YOUR_SERVER_KEY"

Response (200 OK)​

{
"sid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "My App",
"otpDigitLength": 5,
"methods": ["SmsOtp", "WhatsAppOtp", "TelegramMessage"]
}

Response Fields​

FieldTypeDescription
siduuid (string)Application public id
namestringApplication name
otpDigitLengthnumberOTP digit length (typically 5 or 6)
methodsstring[]Configured verification methods for this application

Possible methods values​

  • TelegramMessage
  • WhatsAppMessage
  • SmsOtp
  • WhatsAppOtp
  • TelegramOtp

See Verification Methods for an overview of each method.

Errors​

  • Invalid or missing server key → unauthorized (application not found / invalid server-key)

Get Wallet Balance​

Returns the current wallet balance for the application identified by your server key.

Endpoint: GET https://api.verifyspeed.com/v1/applications/wallet/balance

Request Headers​

  • server-key (required): Server key obtained from the dashboard. Missing or invalid key → unauthorized.
curl -X GET "https://api.verifyspeed.com/v1/applications/wallet/balance" \
-H "server-key: YOUR_SERVER_KEY"

Response (200 OK)​

{
"amount": 12.50000
}

Response Fields​

FieldTypeDescription
amountnumber (decimal)Current application wallet balance (USD)

Errors​

  • Invalid or missing server key → unauthorized

Top Up Wallet​

Creates a pending fund and returns a payment URL from the active online payment provider. After the user completes payment, the wallet balance increases automatically (same payment flow as a dashboard top-up; this is a backend entry point).

Endpoint: POST https://api.verifyspeed.com/v1/applications/wallet/top-up

Request Headers​

  • server-key (required): Server key obtained from the dashboard. Missing or invalid key → unauthorized.
  • Content-Type: application/json

Request Body​

{
"amount": 25
}
FieldTypeRequiredValidationDescription
amountnumber (decimal)yesmin 1, max 100000Top-up amount in USD

Also enforced server-side (from platform settings):

  • Must be ≥ configured online payment minimum
  • Must be ≤ configured online payment maximum (when max is enabled)
  • Online payments must be enabled
  • Application must not be disabled
curl -X POST "https://api.verifyspeed.com/v1/applications/wallet/top-up" \
-H "server-key: YOUR_SERVER_KEY" \
-H "Content-Type: application/json" \
-d "{\"amount\": 25}"

Response (200 OK)​

{
"paymentUrl": "https://payment-provider.example/checkout/...",
"fundId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response Fields​

FieldTypeDescription
paymentUrlstringURL to send the user / open to complete payment
fundIduuid (string)Fund/top-up id for tracking this payment

Behavior​

  • Creates a pending fund and returns a payment URL from the active online payment provider.
  • This does not credit the wallet immediately; the customer must complete payment at paymentUrl.
  • After payment succeeds via webhook, wallet balance increases automatically.
  • Applicable fund bonuses (if any) are applied when payment completes (same as dashboard top-up).

Errors​

  • Invalid or missing server key → unauthorized
  • Online payment disabled → validation error: Online payment is disabled
  • Application disabled → validation error: Application is disabled
  • Amount below minimum → validation error like Cannot fund with amount less than $X
  • Amount above maximum → validation error like Cannot fund with amount greater than $X
  • Body validation: amount outside 1..100000