Developer Documentation

Build with OurREST API

Integrate identity verification into any platform. Clean REST endpoints, webhook events, and comprehensive SDKs for rapid development.

Developer-First Design

Everything you need to integrate identity verification in hours, not weeks.

RESTful Design

Clean, predictable URLs and standard HTTP methods make integration straightforward.

Webhook Events

Real-time notifications when verification status changes. No polling required.

SDK Libraries

Official libraries for Python, Node.js, and PHP. Or use our REST API directly.

Sandbox Testing

Full-featured test environment with mock IDs and simulated verification flows.

Core Endpoints

Simple, powerful endpoints for complete verification workflows.

POST/api/v1/verifications

Create a new verification request for a customer order.

{
  "order_id": "ORD-12345",
  "customer_email": "customer@example.com",
  "target_address": {
    "line1": "123 Main St",
    "city": "Los Angeles",
    "state": "CA",
    "postal_code": "90001"
  }
}
GET/api/v1/verifications/{id}

Retrieve the status and details of a verification request.

{
  "id": "ver_abc123",
  "status": "verified",
  "name_match": { "score": 0.95, "status": "match" },
  "address_match": { "score": 0.92, "status": "match" },
  "age_verified": true
}
POST/api/v1/verifications/{id}/process-id

Submit a customer ID document for processing.

{
  "document_front": "base64_encoded_image...",
  "document_type": "drivers_license"
}
GET/api/v1/widget/config

Get the embedded widget configuration for your checkout page.

{
  "merchant_name": "Your Store",
  "primary_color": "#10B981",
  "logo_url": "https://..."
}

Quick Start

Get up and running in minutes.

1. Get your API credentials

Sign up for a free account to get your API key and secret.

2. Create a verification

curl -X POST https://api.shiptoverified.com/api/v1/verifications \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ORD-12345",
    "customer_email": "customer@example.com",
    "target_address": {
      "line1": "123 Main St",
      "city": "Los Angeles",
      "state": "CA",
      "postal_code": "90001"
    }
  }'

3. Embed the widget

Use the returned widget URL or embed our JavaScript SDK in your checkout.

Ready to Integrate?

Get your API keys and start verifying customers in minutes. Our team is here to help with integration support.