Skip to content
Vouch Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Start here
Overview
How we document
Tutorials
Run Vouch locally, end to end
See the matching algorithm work
How-to guides
Deploy to the cluster
Deploy via CI
Refresh the API reference
Tear down the stack
Restore Postgres from a backup
Operate Vouch with the admin UI and CLI
Reference
Overview
Client protocol
Configuration
Repository layout
API Reference
Overview
admin
List Audit
Overview
List Pairs
Pair Detail
List Reports
Resolve Report
Run Matcher
Sms Outbox
List Users
User Detail
Delete User
Ban User
Unban User
google
Google Callback
Google Start
Google Link Start
auth
Login
Logout
Refresh
Register
Operations
Healthz
me
Get Me
Delete Me
Post Declarations
Export Me
List Identities
Add Password Identity
Delete Identity
Delete Profile
List Sessions
Revoke Session
Put Username
contacts
Put Contact Set
Delete Contact Set
phone
Start
Verify
profile
Get Profile
Put Profile
reports
List My Reports
Create Report
pairs
Post Response
sync
Sync
Explanation
Architecture
The matching protocol
The road to production
Shared FFI core (postponed)
Observability
GitHub
Select theme
Dark
Light
Auto
Overview
vouch
0.1.0
Section titled “vouch 0.1.0”
Information
OpenAPI version:
3.1.0
Operations
Section titled “Operations”
GET
/admin/audit
GET
/admin/overview
GET
/admin/pairs
GET
/admin/pairs/{pair_id}
GET
/admin/reports
POST
/admin/reports/{report_id}/resolve
POST
/admin/run-matcher
GET
/admin/sms/outbox
GET
/admin/users
GET
/admin/users/{user_id}
DELETE
/admin/users/{user_id}
POST
/admin/users/{user_id}/ban
POST
/admin/users/{user_id}/unban
GET
/auth/google/callback
GET
/auth/google/start
GET
/me/identities/google/start
POST
/auth/login
POST
/auth/logout
POST
/auth/refresh
POST
/auth/register
GET
/healthz
GET
/me
DELETE
/me
POST
/me/declarations
GET
/me/export
GET
/me/identities
POST
/me/identities/password
DELETE
/me/identities/{provider}
DELETE
/me/profile
GET
/me/sessions
DELETE
/me/sessions/{session_id}
PUT
/me/username
PUT
/me/contact-set
DELETE
/me/contact-set
POST
/me/phone/start
POST
/me/phone/verify
GET
/me/profile
PUT
/me/profile
GET
/me/reports
POST
/me/reports
POST
/pairs/{pair_id}/response
GET
/sync
Authentication
Section titled “Authentication”
HTTPBearer
Section titled “HTTPBearer”
Security scheme type:
http