VeraFi API Endpoints and Webhooks

1. Authentication and Authorization Endpoints

These endpoints manage login operations, OTP-based login, password reset workflows, session validation, and authentication checks.

These operations validate credentials, generate authentication tokens, and return session details including tenant subscription information.

2. Users Management Endpoints

These endpoints support full CRUD operations for user accounts.

The endpoints include:

• POST /users/
• GET/users/{user_id}
• GET /users/?skip=&limit=
• PUT/users/{user_id}
• DELETE/users/{user_id}

They return user details, pagination support, and account status information.

3. Document Types Management Endpoints

These endpoints retrieve, view, and manage document type configurations.

Endpoints include:

• GET/document-types/?skip=&limit=
• GET/document-types/{document_type_id}
• GET/document-types/by-name/{document_type_name}

These operations return document type metadata, JSON structures, and scoring thresholds.

4. Document Details Management Endpoints

These endpoints are used to manage document field definitions and critical field configurations.

The endpoints include:

• GET/document-detail?document_type=
• POST/document-detail
• POST/document-detail/rename

They return field definitions and allow updating critical status or display labels.

5. Critical Fields & Configuration Endpoints

These endpoints provide access to critical fields and confidence color code configurations.

The endpoints include:

• POST/displaycriticalfield
• GET/fetchconfidencecode

They return field-level weightage details and color-coded confidence thresholds.

6. Verification Logs Endpoints

These endpoints record and retrieve verification logs with filtering and pagination.

Endpoints include:

• POST/insert-logs
• GET/retrieve-logs
• GET/retrieve-logs-count
• GET/user-verification-count

They provide detailed verification history, user-specific counts, and activity filtering.

7. Verification Configuration Endpoints

These endpoints provide and update tenant-level verification settings.

The endpoints include:

• GET/verification-config
• PUT/verification-config

They return and modify verification modules such as liveness, OTP, face match, email verification, and critical fields.

8. Configuration Store Endpoints

These endpoints manage tenant-specific and global configuration settings.

The endpoints include:

• GET/config-store?token=
• POST/config-store?token=

They return configuration key-value pairs for UI appearance, verification behavior, and system parameters.

9. Tenant Management Endpoints

These endpoints permit tenant creation, onboarding, validation, user listing, dashboard data retrieval, and legacy operations.

The endpoints include:

• GET/tenant-management/tenants
• GET/tenant-management/tenants/{tenant_id}/users
• POST/tenant-management/tenants
• POST/tenant-management/onboard
• POST/tenant-management/onboard/validate
• GET/tenant-management/user-dashboard-data
• POST/tenant-management/execute (Legacy multifunction endpoint)

These operations return tenant subscription details, administrative users, usage summaries, and overall tenant analytics.

10. Subscription Management Endpoints

These endpoints handle subscription tiers, services, pricing, and usage statistics.

The endpoints include:

• GET/subscription-management/plans
• GET/subscription-management/pricing/{tier_id}/{service_id}
• CRUD for /subscription-management/tiers
• CRUD for /subscription-management/services
• CRUD for /subscription-management/pricing
• GET/subscription-management/usage/statistics
• GET/subscription-management/usage/tiers
• GET/subscription-management/usage/services

These operations support billing models, feature allocation, usage tracking, and pricing structures.

11. Microservice Proxy (Document Processing) Endpoints

These endpoints forward files for OCR, face analysis, phrase verification, liveness detection, and bank statement processing.

The endpoints include:

• POST/upload
• POST/face
• POST/verify_phrase
• POST/verify_face
• POST/api/liveness
• POST/bank_statement

They return extracted fields, face match results, verification phrases, and bank statement analysis outputs.

12. Verification Services Endpoints

These endpoints perform standalone verification checks.

The endpoints include:

• POST /verification/verify-bank-statement
• POST /verification/verify-pdf-integrity
• POST/verification/verify-ofac
• POST/verification/verify-fraud
• GET/verification/verification-status
• POST/verification/test-verification

They return results of OFAC screening, PDF integrity analysis, fraud detection, and verification system status.

13. OTP Services Endpoints

These endpoints handle SMS and email OTP operations.

The endpoints include:

• POST/send-otp
• POST/verify-otp
• POST /send-email-otp
• POST /verify-email-otp
• GET/resend-timer/{phone_number}
• GET /email-resend-timer/{email}

Supporting development endpoints include:

• GET/debug/otp-storage
• GET /debug/email-otp-storage

14. Feature Management Endpoints

These endpoints control features, main feature categories, and sub-feature hierarchies.

The endpoints include:

• GET/subscription-management/features
• GET/subscription-management/features/main
• GET/subscription-management/features/sub/{main_feature_key}

They return the feature tree used for subscription-based access control.

15. Health & Status Endpoints

These endpoints provide system metadata and API health information.

The endpoints include:

• GET/(Root endpoint)
• GET/health

They return API version, welcome message, and system health status.