Skip to main content
GET
/
v1
/
checks
/
{check_token}
Get check details
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/checks/{check_token} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://instance.prod.onboardapp.io/v1/checks/{check_token}"

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/checks/{check_token}', 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/checks/{check_token}",
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/checks/{check_token}"

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/checks/{check_token}")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://instance.prod.onboardapp.io/v1/checks/{check_token}")

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": "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"
  },
  "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

check_token
string
required

Check token (e.g., chk_abc123).

Pattern: ^chk_[a-zA-Z0-9]+$

Response

Check details.

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

data
object

A verification check executed against a specific provider. Checks are the atomic units of verification — each produces a pass/fail/refer result. Valid results from prior checks can be reused across cases.

meta
object