API Reference
API Reference
VerifiMe Partner API: REST endpoints and webhook specification
The VerifiMe Partner API exposes REST endpoints and one webhook event. All REST requests must be made over HTTPS.
Endpoints
| Method | Path | Description | Environment |
|---|---|---|---|
POST | /v1/user/invite | Create a verification invite for a customer | All |
GET | /v1/user/signup/tracking/{trackingReference}/status | Poll the status of a verification session | All |
POST | /test/tracking/{trackingReference}/verify | Force complete a verification (bypasses Phase 2 processing) | Staging only |
Webhook
| Event | Description |
|---|---|
RISK_ASSESSMENT_UPDATED | Fired when the risk assessment for a customer is complete |
OpenAPI Specification
The full machine-readable specification is available for download. Use it to generate client SDKs, validate requests, or import into your API tooling.