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>'
import requests

url = "https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://instance.prod.onboardapp.io/v1/cases/{case_token}/compliance-report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "case_token": "<string>",
    "case_name": "<string>",
    "case_type": "<string>",
    "case_status": "<string>",
    "decision": "<string>",
    "entities": [
      {
        "token": "ent_8f3k2m1n",
        "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",
        "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>",
        "provider": "WorldCheck",
        "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>",
        "priority_score": 50,
        "sla_deadline": "2023-11-07T05:31:56Z",
        "match_score": 50,
        "ai_assessment": "<string>",
        "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>",
      "overall_score": 50,
      "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
            }
          ]
        }
      },
      "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>"
        },
        "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
    }
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}

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