Partner API Quickstart

Integrate TrustScore lookup, risk scoring, and webhook alerts in under 30 minutes.

Back to For Platforms Open Partner Usage Portal

1) Lookup API

Verify business trust status before order confirmation.

curl -X GET "https://trustscore.africa/api/partner/v1/lookup?id=abidjan-cocoa-exporters" \
  -H "x-api-key: YOUR_API_KEY"

Returns verification status, trust score, suspicious flag, and profile URL.

2) Risk Score API

Use explainable risk signals for policy-driven decisions.

curl -X GET "https://trustscore.africa/api/partner/v1/score?id=abidjan-cocoa-exporters" \
  -H "x-api-key: YOUR_API_KEY"

Returns risk score, risk level, confidence, and explanation reasons.

3) Webhook Subscriptions

Receive push alerts for high-risk events.

curl -X POST "https://trustscore.africa/api/partner/v1/webhooks" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "endpointUrl": "https://example.com/trustscore/webhook",
    "events": ["risk.high", "verification.updated"]
  }'

Test delivery with /api/partner/v1/webhooks/test after registration.

Response Signature Verification

Optional tamper-evidence headers for regulated workflows.

When enabled, responses include x-trustscore-signature and x-trustscore-timestamp headers. Use your shared signing secret to verify payload integrity.