CorebanqCorebanq Developer Docs
KYT

Description

Overview

The KYT (Know Your Transaction) package provides functionality for monitoring and analyzing financial transactions for compliance purposes. It helps identify suspicious activities and ensures regulatory compliance by analyzing transaction patterns and metadata.

API Methods

Get All KYT Responses

GET /v1/kyt

Retrieves all KYT transaction responses with pagination support. This endpoint allows compliance officers and risk managers to review transaction monitoring results across the system.

Query Parameters

  • limit (integer): Maximum number of records to return
  • offset (integer): Number of records to skip for pagination

Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "transaction_id": "987fcdeb-51a2-43f1-9b2c-8d7e6f5a4b3c",
    "status": "Not Suspicious",
    "label": "All Good",
    "risk_score": 0.1,
    "created_at": "2024-03-20T10:00:00Z",
    "updated_at": "2024-03-20T10:00:00Z"
  }
]

Get KYT Response by Transaction ID

GET /v1/kyt/{transaction_id}

Retrieves KYT analysis results for a specific transaction by its ID. This endpoint provides detailed compliance information for individual transactions.

Path Parameters

  • transaction_id (uuid): Unique identifier of the transaction to analyze

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "transaction_id": "987fcdeb-51a2-43f1-9b2c-8d7e6f5a4b3c",
  "status": "Not Suspicious",
  "label": "All Good",
  "risk_score": 0.1,
  "analysis_details": {
    "source_risk": "low",
    "destination_risk": "low",
    "amount_risk": "low",
    "frequency_risk": "low"
  },
  "created_at": "2024-03-20T10:00:00Z",
  "updated_at": "2024-03-20T10:00:00Z"
}

Status Values

The KYT system uses predefined status values to categorize transaction risk:

  • Not Suspicious: Transaction passed all compliance checks
  • Open: Transaction requires further investigation
  • Suspicious: Transaction flagged for potential compliance issues

Label Values

Transaction labels provide quick visual indicators:

  • All Good: No compliance concerns detected
  • Soft Stop: Minor compliance issues requiring attention
  • Hard Stop: Serious compliance violations requiring immediate action

Use Cases

  • Compliance Monitoring: Automated screening of financial transactions
  • Risk Assessment: Evaluation of transaction risk levels
  • Regulatory Reporting: Support for regulatory compliance requirements
  • Fraud Detection: Identification of potentially fraudulent activities
  • Audit Trail: Comprehensive record of compliance decisions

On this page