API reference

This reference covers fintech integration endpoints.

Base URL

Replace {BASE_URL} with the URL provided by Kairo Connect:

Environment	Example
Staging	`https://staging-api.kairoshield.com`
Production	`https://api.kairoshield.com`

All integration routes live under {BASE_URL}/api/v1.

Method	Path	Description
`POST`	`/score`	Real-time fraud scoring for one transaction
`POST`	`/score/batch`	Batch scoring (up to 1,000 transactions)
`POST`	`/feedback`	Confirmed fraud or legitimate label
`POST`	`/webhooks`	Register webhook
`GET`	`/webhooks`	List client webhooks
`GET`	`/webhooks/{id}`	Get one webhook
`PUT`	`/webhooks/{id}`	Update webhook
`DELETE`	`/webhooks/{id}`	Delete webhook
`GET`	`/webhooks/{id}/logs`	Delivery history
`POST`	`/webhooks/{id}/test`	Send test payload

Method	Path	Purpose
`GET`	`/health`	Liveness — process is alive

All integration routes require the X-API-Key header. See Authentication.

Errors follow RFC 7807 (Problem Details). See Common errors.