KYCVerifyResponse

verification_idstring<uuid>

UUID of the persisted verification record for audit trail

verifiedboolean

True when confidence is "high" or "medium". False for "low" confidence (e.g. manual submissions, gps_code with quality_score < 0.6).

hex_codestring

Example: AF-GH-7-0GXTQD5RFZZZZ

ghanapost_codestring

Example: GD1920070

address object

regionstring

districtstring

areastring

postcodestring

quality_scorenumber<double>

0.0-1.0 confidence based on data completeness

verification object

methodstring

accuracy_metersinteger

timestampstring<date-time>

confidencestring

Possible values: [low, medium, high]

risk_signals object

known_residential_areaboolean

Location exists in the address database

address_densitystring

How many prior verifications in this hex zone

Possible values: [low, medium, high, unknown]

previously_verified_by_othersboolean

Other customers have verified addresses in this zone

fraud_check object

Real-time fraud detection results (omitted if fraud detector unavailable)

blockedboolean

Whether the transaction was blocked (risk_score >= 0.8)

Example: false

risk_scorenumber<double>

Cumulative risk score from all detected signals

Possible values: >= 0 and <= 1

Example: 0.25

risk_levelstring

Risk classification based on score thresholds

Possible values: [low, medium, high, critical]

Example: low

signals object[]

Individual fraud signals detected

Array [

typestring

Signal type identifier

Possible values: [velocity_abuse, velocity_suspicious, impossible_travel, suspicious_travel, bulk_fraud, new_customer, manual_entry, off_hours]

Example: new_customer

severitystring

Signal severity level

Possible values: [low, medium, high, critical]

Example: low

descriptionstring

Human-readable explanation of the signal

Example: First verification for this customer

scorenumber<double>

Contribution to total risk score

Example: 0.1

]

recommendationstring

Human-readable action recommendation

Example: Approve transaction

KYCVerifyResponse

{
  "verification_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verified": true,
  "hex_code": "AF-GH-7-0GXTQD5RFZZZZ",
  "ghanapost_code": "GD1920070",
  "address": {
    "region": "string",
    "district": "string",
    "area": "string",
    "postcode": "string"
  },
  "quality_score": 0,
  "verification": {
    "method": "string",
    "accuracy_meters": 0,
    "timestamp": "2024-07-29T15:51:28.071Z",
    "confidence": "low"
  },
  "risk_signals": {
    "known_residential_area": true,
    "address_density": "low",
    "previously_verified_by_others": true
  },
  "fraud_check": {
    "blocked": false,
    "risk_score": 0.25,
    "risk_level": "low",
    "signals": [
      {
        "type": "new_customer",
        "severity": "low",
        "description": "First verification for this customer",
        "score": 0.1
      }
    ],
    "recommendation": "Approve transaction"
  }
}