US Virtual Notary - Developers Guide: REST API Reference (v3)

Programmatic access to create, read, and manage resources such as appointments, reservations, documents, signers and videos.

Base URL & Versioning

Base: http://sandbox.usvirtualnotary.com/wp-json/v3
Status: Stable

All endpoints are prefixed with /wp-json/v3. Older versions remain available but may be deprecated over time.

Authentication

v3 uses bearer tokens (no Basic Auth). Include your token in the Authorization header.

Authorization: Bearer YOUR_TOKEN

Errors

We use standard HTTP status codes. Error bodies include a short code and message.

{
    "error": {
        "code": "invalid_request",
        "message": "Missing required parameter: id"
    }
}

Pagination

List endpoints support cursor-based pagination with limit (default 25, max 100).

GET http://sandbox.usvirtualnotary.com/wp-json/v3/appointments?limit=25&cursor=eyJwYWdlIjoxfQ=

Rate Limits

Reasonable default limits apply. Responses include X-RateLimit-* headers when relevant.

Get Reservation

Get Appointment

curl -sS \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  https://usvirtualnotary.com/wp-json/v3/appointments/823451

{
    "object": "appointment",
    "id": 275867,
    "status": "draft",
    "timestamp": "2025-08-24T18:27:45+00:00",
    "timezone": "America/New_York",
    "service": "remote",
    "signing_method": "remote",
    "quantity": 1,
    "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com"
    },
    "lang": "en",
    "keys": {
        "appointment": "DgnlniHMkEbEl6UAGEFLp",
        "upload": "X67RAgOKzCj61sWHVHLWm",
        "session": "k4Njq7zyGbmG1mHsKRqn6"
    },
    "links": {
        "self": "https://usvirtualnotary.com/wp-json/v3/appointments/275867"
    }
}

{
    "error": {
        "code": "not_found",
        "message": "Appointment not found."
    }
}

List Appointments