Smile Identity API Reference

OpenAPI 3.0 specifications for the Smile Identity v3 API.

Endpoints

Spec	Endpoint	Description
Biometric Authentication	POST /v3/authentication	Submit biometric authentication
Biometric Enrollment	POST /v3/registration	Submit biometric enrollment
Biometric KYC	POST /v3/biometric_kyc	Submit Biometric KYC verification
Block User	POST /v3/users/{user_id}	Block or unblock an enrolled user
Document Verification	POST /v3/document-verification	Submit Document Verification
Enhanced Document Verification	POST /v3/enhanced-document-verification	Submit Enhanced Document Verification
Enhanced KYC	POST /v3/enhanced_kyc	Submit Enhanced KYC verification
Replay Callback	POST /v3/replay/{job_id}	Replay a callback for a completed verification
Services	GET /v3/services/bank_codes	List bank codes
Services	GET /v3/services/id_status	Get ID type availability status
Services	GET /v3/services/supported_documents	List supported documents for verification
Services	GET /v3/services/supported_id_types	List supported KYC ID types
Smart Selfie Compare	POST /v3/smart_selfie_compare	Submit smart selfie compare
Token	POST /v3/token	Generate v3 Auth Token
Verification Status	GET /v3/status/{jobId}	Get verification status

The table above is regenerated automatically on each spec sync. Don't hand-edit between the markers.

Documentation

Rendered API documentation is available via GitHub Pages.

Using the Specs

Import into Postman

1. Open Postman → Import → File
2. Select any spec from specs/v3/
3. Postman will generate a collection with all endpoints and example requests

Generate Client SDKs

Use OpenAPI Generator directly against any spec file:

npx @openapitools/openapi-generator-cli generate \
  -i specs/v3/v3-token.yaml \
  -g python \
  -o ./generated-client

Validate Specs

npx --yes @stoplight/spectral-cli@^6.14.0 lint specs/v3/*.yaml

Versioning

Specs are versioned and released alongside the Smile Identity v3 API. Each release here corresponds to a deployed API version; see CHANGELOG.md for version history and Releases for tagged versions.

Links

• Smile Identity Documentation
• API Status