Developers

API Reference

A clean REST API to integrate CredVault with your HRIS, scheduling, and identity systems.

Base URL

https://api.credvault.io

Authentication

Authorization: Bearer cv_live_…

Versioning

All endpoints are versioned under /v1. Breaking changes ship under new versions.

Rate limits

600 req/min per key. Burst up to 100 req/sec.

Endpoints

GET

/v1/credentials

List credentials with filters (status, type, owner).

POST

/v1/credentials

Create a new credential.

GET

/v1/credentials/{id}

Retrieve a single credential.

PATCH

/v1/credentials/{id}

Update credential fields.

DELETE

/v1/credentials/{id}

Remove a credential.

POST

/v1/credentials/{id}/approve

Approve a pending submission.

GET

/v1/staff

List workforce members.

POST

/v1/staff

Add a new staff member.

GET

/v1/reminders

Upcoming expiry reminders.

GET

/v1/reports/compliance

Compliance score by team.

POST

/v1/webhooks

Subscribe to credential & approval events.

GET

/v1/billing/subscriptions

List subscription plans (admin).

Example: create a credential

curl -X POST https://api.credvault.io/v1/credentials \
  -H "Authorization: Bearer cv_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "RN License",
    "type": "License",
    "ownerId": "u-emp-1",
    "issuer": "State Board of Nursing",
    "issuedOn": "2024-04-12",
    "expiresOn": "2026-04-12"
  }'