Authentication
Include your API key in the Authorization header. Keys start with vb_live_ and are shown only once at creation.
Authorization: Bearer vb_live_XXXXXXXXXXXXXXXX Content-Type: application/json
POST /checks
Order a background check. Deducts 1 credit.
curl -X POST https://www.volunteerbadge.com/api/v1/checks \
-H "Authorization: Bearer vb_live_..." \
-H "Content-Type: application/json" \
-d '{
"firstName": "Jane",
"lastName": "Smith",
"dob": "03/15/1985",
"ssn": "123456789",
"address": "123 Main St",
"city": "Chicago",
"state": "IL",
"zip": "60601"
}'GET /checks/:id
Poll for check status and result.
POST /applications
Send a volunteer application invite.
{
"templateId": "uuid",
"email": "volunteer@example.com",
"deliveryMethod": "email"
}GET /volunteers
Paginated volunteer list. Query params: page, limit, status.
POST /chat
Natural-language endpoint for API customers. Send plain English requests to run checks or query credits.
Webhooks
Events: check.complete, check.error, application.submitted, volunteer.created. Payloads are signed with HMAC-SHA256 in the X-VolunteerBadge-Signature header.