Quickstart
Your first call in 30 seconds
evaluate.sh
# Evaluate a credit bureau report
curl -X POST https://api.neetix.ai/v1/bureau/evaluate \
-H "Authorization: HMAC <token>" \
-H "Idempotency-Key: txn_20240315_001" \
-d '{
"user_id": "USR_7829",
"reference_id": "REF_20240315_001",
"format_type": "CibilJson",
"raw_data": "eyJhY2NvdW50Li4u"
}'
# Response — 28ms
{
"score": 742,
"risk_grade": "B+",
"decision": "APPROVED",
"features_extracted": 825,
"processing_time_ms": 28
}Reference
Endpoints
All endpoints versioned under /v1/. Postman collection covers every endpoint with example payloads.
POST/v1/bureau/evaluate
POST/v1/bureau/explain
GET/v1/bureau/{id}/requests/{ref}/raw
POST/v1/merchants
GET/v1/merchants
PUT/v1/merchants/{id}
POST/v1/merchants/{id}/api-keys
POST/v1/merchants/{id}/api-keys/{kid}/rotate
DEL/v1/merchants/{id}/api-keys/{kid}
Platform primitives
What you get on every request
HMAC auth
SHA-256 signed requests, API keys with rotation, IP whitelisting.
Idempotency
Pass an Idempotency-Key. Retry safely. Same response, no double-charge.
Webhooks
Subscribe to decision events. Signed payloads. Auto-retry with exponential backoff.
Never 5xx
Internal errors always return a structured response with a fallback decision.