NeuroID Developer Documentation
NeuroID is an identity verification API for biometric and document checks. The current API supports fingerprint enrollment, fingerprint verification, face matching, legacy ID-card validation, and a unified verification flow that runs all checks in sequence.
This folder is the starter documentation package for the NeuroID developer portal POC. It is intended to be mounted later under:
https://developer.neuronixtech.net/products/neuroid
Portal Metadata
Suggested meta description:
<meta name="description" content="Integrate NeuroID identity verification APIs for fingerprint enrollment, biometric face matching, ID-card checks, and unified KYC verification workflows.">
Documentation Pages
- Quickstart
- Integration Guide
- Errors and Statuses
- OpenAPI Reference
- Developer Portal POC Plan
- Deployment Handoff
Current API Surface
| Method | Endpoint | Purpose |
| --- | --- | --- |
| POST | /v2/verify | Run fingerprint, face match, and ID-card checks in sequence. |
| POST | /v2/enroll-fp | Enroll a fingerprint against a mobile number. |
| POST | /v2/verify-fp | Verify a fingerprint against stored identities. |
| POST | /v2/match-faces | Compare a selfie with an ID-card face image. |
| POST | /v1/verify | Legacy ID-card validation endpoint. |
Documentation Source
This first version is generated from the local FastAPI implementation in api/main.py and the service responses in api/services/verification.py.
Before commercial release, confirm:
- Production and sandbox base URLs.
- Authentication scheme.
- Supported file formats and size limits.
- Commercial SLAs, rate limits, and data retention policy.
- Whether legacy
/v1/verifyshould be public or hidden.