Get risk assessment
curl --request GET \
--url https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment \
--header 'X-API-KEY: <api-key>'import requests
url = "https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment"
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}/risk-assessment', 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}/risk-assessment",
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}/risk-assessment"
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}/risk-assessment")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment")
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": {
"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"
},
"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>"
}
]
}
}Cases
Get risk assessment
Retrieve the current active risk assessment for a case. Returns the overall score, tier classification, and dimension-level breakdown.
GET
/
v1
/
cases
/
{case_token}
/
risk-assessment
Get risk assessment
curl --request GET \
--url https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment \
--header 'X-API-KEY: <api-key>'import requests
url = "https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment"
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}/risk-assessment', 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}/risk-assessment",
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}/risk-assessment"
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}/risk-assessment")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment")
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": {
"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"
},
"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
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.
Response
Current risk assessment.
Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.
⌘I