Skip to content
Asqary Docs

Overview

Asqary API 1.0.0

Section titled “Asqary API 1.0.0”

Transaction risk decisioning for digital lenders. Send transactions to POST /v1/score and receive a 0–100 risk score, risk level, confidence, recommended action and explainable reasons under a versioned policy.

Identifiers (customer, device, beneficiary account, BVN, phone) are never sent raw: they must be 64-character lowercase hex HMAC-SHA256 hashes made with a key only you hold. See docs/api.md#identifier-hashing for the exact algorithm, key rules and test vectors.

Every response carries an X-Request-Id header, also returned as request_id in error bodies. Send your own X-Request-Id to correlate logs.

Information

  • License: Proprietary. All rights reserved.
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/v1/score
GET
/v1/decisions
GET
/v1/decisions/{decision_id}
GET
/v1/rules
GET
/v1/policies
POST
/v1/policies
GET
/v1/policies/{policy_id}
DELETE
/v1/policies/{policy_id}
PATCH
/v1/policies/{policy_id}
GET
/v1/policies/{policy_id}/versions/{version}
POST
/v1/policies/{policy_id}/activate
POST
/v1/policies/{policy_id}/archive
GET
/v1/backtest
POST
/v1/backtest
GET
/v1/backtest/{backtest_id}
GET
/v1/backtest/{backtest_id}/rows
POST
/v1/feedback
GET
/v1/webhooks
POST
/v1/webhooks
GET
/v1/webhooks/{webhook_id}
DELETE
/v1/webhooks/{webhook_id}
PATCH
/v1/webhooks/{webhook_id}
POST
/v1/webhooks/{webhook_id}/rotate-secret
POST
/v1/webhooks/{webhook_id}/test
GET
/v1/webhooks/{webhook_id}/deliveries
GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}
POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

asq_live_… or asq_test_…. The key’s kind selects live or test data.

Security scheme type: http