Provd logo
Docs

API Reference

Endpoints, fields, and responses.

Base path: /api/v1

Authentication

Protected endpoints accept either:

  • Authorization: Bearer <jwt_token>
  • X-API-Key: <api_key>

POST /api/v1/trust/score

Required scope: trust:read

Returns a counterparty risk score and reason flags for a trade context.

Request fields

  • entity_id (string)
  • amount (number)
  • currency (string)
  • context (object)

Example request

{
  "entity_id": "entity-123",
  "amount": 250,
  "currency": "USDT",
  "context": {}
}

Response fields

  • score (number)
  • risk_level (string)
  • signals (array)
  • cached (boolean)

Example response

{
  "entity_id": "entity-123",
  "score": 0.82,
  "risk_level": "low",
  "signals": [
    { "name": "trade_consistency", "value": 0.88, "weight": 0.4 }
  ],
  "cached": false
}

POST /api/v1/dispute/analyze

Required scope: dispute:analyze

Returns a recommendation and confidence score for a dispute case.

Key management endpoints

  • GET /api/v1/keys (scope: keys:read)
  • POST /api/v1/keys (scope: keys:write)
  • DELETE /api/v1/keys/{key_id} (scope: keys:write)

Notes

  • Call this endpoint before releasing crypto or fiat.
  • Treat risk_flags as operator-facing reasons, not just UI labels.
  • Pair this endpoint with your internal review and dispute workflows.