Skip to main content
POST
/
v1
/
risk-assessments
/
{assessment_token}
/
approve
Approve risk assessment
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/risk-assessments/{assessment_token}/approve \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "notes": "<string>"
}
'
import requests

url = "https://instance.prod.onboardapp.io/v1/risk-assessments/{assessment_token}/approve"

payload = { "notes": "<string>" }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({notes: '<string>'})
};

fetch('https://instance.prod.onboardapp.io/v1/risk-assessments/{assessment_token}/approve', 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/risk-assessments/{assessment_token}/approve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://instance.prod.onboardapp.io/v1/risk-assessments/{assessment_token}/approve"

payload := strings.NewReader("{\n \"notes\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://instance.prod.onboardapp.io/v1/risk-assessments/{assessment_token}/approve")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"notes\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://instance.prod.onboardapp.io/v1/risk-assessments/{assessment_token}/approve")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"notes\": \"<string>\"\n}"

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>"
}
]
}
}
{
"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.

Headers

Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Path Parameters

assessment_token
string
required

Risk assessment token.

Body

application/json
notes
string

Optional approval notes.

Maximum string length: 2000

Response

Assessment approved.

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

data
object

A 4-dimension risk assessment that scores an entity across customer, geographic, product/service, and transaction dimensions. The overall score determines the risk tier and drives the due diligence path.

meta
object