API Documentation

Complete API reference for integrating ContactVerify into your applications.

Base URL

https://contactverify-joba123-api.greenbush-881e5440.eastus.azurecontainerapps.io

Authentication

Authorization: Bearer YOUR_API_KEY

Quick Example (cURL)

curl -X POST https://contactverify-joba123-api.greenbush-881e5440.eastus.azurecontainerapps.io
/v1/contact/send-code \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel": "EMAIL", "email": "user@example.com", "purpose": "login"}'

Endpoints

POST/v1/contact/send-code

Send a verification code (OTP) via Email, WhatsApp, or SMS

{
  "channel": "EMAIL",       // Required: "EMAIL", "WHATSAPP", or "SMS"
  "email": "user@example.com",  // Required for EMAIL channel
  "whatsappNumber": "+1234567890",  // Required for WHATSAPP/SMS
  "country": "US",          // Optional: 2-letter country code
  "purpose": "registration" // Optional: label for tracking
}

POST/v1/contact/verify-code

Verify an OTP code sent previously

{
  "requestId": "b1efc76d-9094-4857-b6f1-fbbbb9dec9a5",
  "otpCode": "123456"
}

GET/health

Check API health status

No request body required

Error Codes

Code	Status	Description
400	Bad Request	Invalid request parameters
401	Unauthorized	Invalid or missing API key
404	Not Found	Resource not found
429	Too Many Requests	Rate limit exceeded
500	Internal Error	Server error, please retry

Official SDKs

Get started faster with our official client libraries.

Node.js

Python

Java

Ruby

PHP

Rust