CoreVouch API

The CoreVouch API allows you to programmatically access reviews, send invitations, and embed widgets on your website. All API requests should be made to:

https://www.corevouch.com/api/v1/

Authentication

All API requests require authentication using your API key. Include your API key in the Authorization header:

curl -X GET "https://www.corevouch.com/api/v1/reviews" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Find your API key: Go to Dashboard → Settings → API Access

Rate Limits

API requests are rate-limited based on your plan:

Plan	Requests/Hour	Requests/Day
Free	100	1,000
Starter	500	5,000
Professional	2,000	20,000
Enterprise	Unlimited	Unlimited

Business Information

GET /api/v1/business

Retrieve your business profile, trust score, and review statistics.

View Response Example

{
  "success": true,
  "data": {
    "id": 1,
    "name": "TaraSkinCare",
    "slug": "Skincare",
    "trust_score": 87,
    "rating_avg": 4.8,
    "review_count": 156,
    "verification_status": "verified",
    "response_rate": 92,
    "created_at": "2024-01-15T10:30:00Z"
  }
}

GET /api/v1/business/widget

Get widget data for embedding on your website.

View Response Example

{
  "success": true,
  "data": {
    "business_name": "TaraSkinCare",
    "trust_score": 87,
    "rating_avg": 4.8,
    "review_count": 156,
    "recent_reviews": [
      {
        "reviewer_name": "John D.",
        "rating": 5,
        "content": "Excellent products!",
        "created_at": "2024-01-10"
      }
    ]
  }
}

Reviews

GET /api/v1/reviews

List all reviews for your business with pagination and filters.

Query Parameters:

page - Page number (default: 1)
per_page - Results per page (default: 20, max: 100)
status - Filter by status (published, pending, hidden)
rating - Filter by rating (1-5)
verified_only - Only verified reviews (true/false)

View Response Example

{
  "success": true,
  "data": [
    {
      "id": 123,
      "reviewer_name": "John D.",
      "rating": 5,
      "title": "Amazing experience",
      "content": "Great products and fast shipping!",
      "verification_type": "verified_purchase",
      "created_at": "2024-01-10T14:30:00Z",
      "reply": {
        "content": "Thank you for your feedback!",
        "replied_at": "2024-01-11T09:00:00Z"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 8,
    "total_count": 156
  }
}

GET /api/v1/reviews/stats

Get review statistics and rating distribution.

View Response Example

{
  "success": true,
  "data": {
    "total_reviews": 156,
    "average_rating": 4.8,
    "rating_distribution": {
      "5": 98,
      "4": 42,
      "3": 10,
      "2": 4,
      "1": 2
    },
    "verified_count": 134,
    "response_rate": 92
  }
}

POST /api/v1/reviews/{id}/reply

Reply to a specific review.

Request Body:

{
  "content": "Thank you for your feedback! We're glad you enjoyed our products."
}

Review Invitations

GET /api/v1/invitations

List all review invitations sent by your business.

POST /api/v1/invitations

Send a review invitation to a customer.

Request Body:

{
  "customer_name": "John Doe",
  "customer_email": "[email protected]",
  "order_id": "ORD-12345",
  "product_name": "Skin Care Bundle"
}

View Response Example

{
  "success": true,
  "data": {
    "id": 789,
    "token": "abc123xyz",
    "customer_email": "[email protected]",
    "status": "sent",
    "review_url": "https://www.corevouch.com/review/abc123xyz",
    "expires_at": "2024-02-10T10:30:00Z"
  }
}

Widgets

Embed review widgets on your website using these endpoints or the embed code from your dashboard.

GET /api/widget/{api_key}

Get widget data for custom implementations.

GET /widget/{slug}/badge

Renders a trust badge widget (HTML).

GET /widget/{slug}/carousel

Renders a review carousel widget (HTML).

Embed Code Example

<!-- CoreVouch Trust Badge -->
<div id="corevouch-badge"></div>
<script src="https://www.corevouch.com/widget/YOUR_SLUG/badge.js"></script>

Error Codes

Code	Status	Description
200	OK	Request successful
201	Created	Resource created successfully
400	Bad Request	Invalid request parameters
401	Unauthorized	Invalid or missing API key
403	Forbidden	Access denied (domain not allowed)
404	Not Found	Resource not found
429	Too Many Requests	Rate limit exceeded
500	Server Error	Internal server error

Webhooks

Configure webhooks to receive real-time notifications when events occur. Set up your webhook URL in Dashboard → Settings.

Available Events:

review.created - New review submitted
review.published - Review approved and published
review.flagged - Review reported by user
invitation.completed - Customer completed review invitation

View Webhook Payload Example

{
  "event": "review.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "review_id": 123,
    "business_id": 1,
    "reviewer_name": "John D.",
    "rating": 5,
    "status": "pending"
  }
}

CoreVouch API

Authentication

Rate Limits

Business Information

Reviews

Review Invitations

Widgets

Embed Code Example

Error Codes

Webhooks

Need Help?