NeuroID Quickstart

This guide shows the shortest path to integrate NeuroID identity verification.

Base URL

Use the environment URL provided by NeuroID.

Sandbox:    https://sandbox-api.neuronixtech.net/neuroid
Production: https://api.neuronixtech.net/neuroid

These URLs are placeholders for the portal POC and should be replaced with the final gateway URLs.

Authentication

Authentication is not currently defined in the local FastAPI service. For commercial use, expose the API through a gateway and require an API key or bearer token.

Recommended header:

Authorization: Bearer <access_token>

Step 1: Enroll a Fingerprint

Enroll the user's fingerprint before running verification.

curl -X POST "$BASE_URL/v2/enroll-fp" \
  -H "Authorization: Bearer $NEUROID_TOKEN" \
  -F "mobile_number=923001234567" \
  -F "file=@fingerprint.jpg"

Successful response:

{
  "status": "SUCCESS",
  "message": "Fingerprint enrolled"
}

Step 2: Run Unified Verification

Use /v2/verify for the complete verification flow.

curl -X POST "$BASE_URL/v2/verify" \
  -H "Authorization: Bearer $NEUROID_TOKEN" \
  -F "mobile_number=923001234567" \
  -F "fingerprint=@fingerprint.jpg" \
  -F "selfie=@selfie.jpg" \
  -F "id_card=@id-card.jpg"

Success response:

{
  "status": "SUCCESS",
  "message": "All verification checks passed successfully.",
  "details": {
    "fingerprint": {
      "status": "SUCCESS",
      "mobile_number": "923001234567",
      "score": 0.2148,
      "message": "Identity verified"
    },
    "face_match": {
      "status": "SUCCESS",
      "score": 0.7832,
      "message": "Faces match"
    },
    "id_card": {
      "status": "SUCCESS",
      "verification_score": 0.8421,
      "feature_detected": "pak-flag",
      "message": "Valid ID"
    }
  }
}

Rejection Handling

If any check fails, the API returns the failed step and the rejection result.

{
  "step": "face_match",
  "status": "REJECTED",
  "score": 1.4821,
  "message": "Faces do not match"
}

Common rejection steps:

| Step | Meaning | | --- | --- | | fingerprint | Fingerprint did not match the enrolled mobile number. | | face_match | Selfie face did not match the ID-card face. | | id_card_check | Required ID-card security feature was not detected. |

Recommended Image Guidance

• Use clear, well-lit images.
• Avoid glare on ID-card photos.
• Keep the face fully visible in selfie and ID-card images.
• Use a clean fingerprint image with enough ridge detail.
• Re-enroll fingerprint data when the fingerprint model changes.