Skip to main content
GET
/
v1
/
cases
/
{case_token}
/
compliance-report
Generate compliance report
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "case_token": "<string>",
    "case_name": "<string>",
    "case_type": "<string>",
    "case_status": "<string>",
    "decision": "<string>",
    "entities": [
      {
        "token": "ent_8f3k2m1n",
        "type": "Person",
        "first_name": "John",
        "last_name": "Smith",
        "full_name": "John Smith",
        "company_name": "<string>",
        "date_of_birth": "2023-12-25",
        "nationality": "GB",
        "registration_number": "<string>",
        "country": "GB",
        "role": "Primary",
        "verification_status": "Not Started",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "checks_summary": {
          "total": 123,
          "complete": 123,
          "pending": 123,
          "failed": 123
        },
        "alerts_summary": {
          "total": 123,
          "open": 123,
          "resolved": 123
        },
        "external_reference": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "checks": [
      {
        "token": "chk_5n8p3q1r",
        "entity_token": "<string>",
        "type_code": "<string>",
        "category": "Identity",
        "status": "Pending",
        "result": "Pass",
        "provider": "WorldCheck",
        "execution_method": "API",
        "result_data": {},
        "alerts_generated": 123,
        "waive_reason": "<string>",
        "retry_count": 0,
        "valid_until": "2023-11-07T05:31:56Z",
        "executed_at": "2023-11-07T05:31:56Z",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "alerts": [
      {
        "token": "alt_3j7k9m2n",
        "case_token": "<string>",
        "entity_token": "<string>",
        "type": "Identity",
        "category": "PEP Match",
        "status": "Open",
        "priority": "Critical",
        "priority_score": 50,
        "sla_deadline": "2023-11-07T05:31:56Z",
        "sla_status": "On Track",
        "match_score": 50,
        "ai_assessment": "<string>",
        "resolution_action": "Approve",
        "resolution_rationale": "<string>",
        "resolved_by": "<string>",
        "resolved_at": "2023-11-07T05:31:56Z",
        "assigned_to": "<string>",
        "is_false_positive": false,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "risk_assessment": {
      "token": "rsk_2m6n4p8q",
      "case_token": "<string>",
      "status": "Draft",
      "overall_score": 50,
      "tier": "High",
      "dimensions": {
        "customer": {
          "score": 50,
          "weight": 123,
          "weighted_score": 123,
          "factors": [
            {
              "name": "<string>",
              "value": "<string>",
              "score_contribution": 123
            }
          ]
        },
        "geographic": {
          "score": 50,
          "weight": 123,
          "weighted_score": 123,
          "factors": [
            {
              "name": "<string>",
              "value": "<string>",
              "score_contribution": 123
            }
          ]
        },
        "product_service": {
          "score": 50,
          "weight": 123,
          "weighted_score": 123,
          "factors": [
            {
              "name": "<string>",
              "value": "<string>",
              "score_contribution": 123
            }
          ]
        },
        "transaction": {
          "score": 50,
          "weight": 123,
          "weighted_score": 123,
          "factors": [
            {
              "name": "<string>",
              "value": "<string>",
              "score_contribution": 123
            }
          ]
        }
      },
      "due_diligence_path": "SDD",
      "review_frequency": "6 Months",
      "override_tier": "High",
      "override_justification": "<string>",
      "approved_by": "<string>",
      "approved_at": "2023-11-07T05:31:56Z",
      "model_version": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "timeline": [
      {
        "token": "aud_4t8u2v6w",
        "event_type": "<string>",
        "actor": {
          "user_id": "<string>",
          "name": "<string>",
          "type": "user"
        },
        "target_type": "case",
        "target_token": "<string>",
        "details": {},
        "ip_address": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "generated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Path Parameters

case_token
string
required

Case token.

Query Parameters

format
enum<string>
default:json

Report output format.

Available options:
json,
pdf

Response

Compliance report.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

data
object

Comprehensive compliance report for a case, suitable for regulatory submission. Includes entity details, check results, alert resolutions, risk assessment, and audit trail.

meta
object