Introduction

The KryoGuard API provides a powerful set of tools to automate and streamline your compliance workflows. With our RESTful API, you can integrate key compliance tasks such as sanction screening, identity verification, KYC/KYB processes, transaction monitoring, and terms of service enforcement directly into your applications.

Our API is designed with simplicity and scalability in mind, offering predictable resource-oriented URLs, clear authentication methods, and easy-to-understand request and response formats. Whether you're managing large-scale operations or focusing on specific compliance tasks, the KryoGuard API is built to fit seamlessly into your existing systems.

In this documentation, you'll find everything you need to get started with the KryoGuard API—detailed guides, reference materials, and code examples to help you integrate, test, and implement our solutions with ease.

Authentication

KryoGuard uses OAuth 2.0's Client Credentials Grant to authenticate API requests. This method allows your application to obtain an access token using your client_id and client_secret.

You will need to include this token in the Authorization header for all subsequent API requests.

POST https://auth.kryoguard.com/realms/kryoguard-dev/protocol/openid-connect/token

Request Headers

Request Parameter

Here's an example on how to obtain an access token:

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
public class KryoGuardAuth {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://auth.kryoguard.com/realms/kryoguard-dev/protocol/openid-connect/token"))
            .header("Content-Type", "application/x-www-form-urlencoded")
            .POST(HttpRequest.BodyPublishers.ofString(
                "grant_type=client_credentials&client_id=kryoguard-client&client_secret=YOUR_CLIENT_SECRET&scope=openid"
            ))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Sanction Screening

The Sanctions Search API allows developers to search for individuals, entities, and documents within the OFAC (Office of Foreign Assets Control), UN (United Nations), and UK (United Kingdom) sanction lists. This endpoint helps in automating compliance checks by providing detailed results based on the search criteria provided.

POST /api/search

https://api-dev.kryoguard.com/api/search

import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;

public class SearchSanction {
    public static void main(String[] args) throws Exception {
        String url = "http://localhost:8080/api/search";
        String token = "Bearer <YOUR_JWT_TOKEN>";

        // JSON request body
        String jsonInputString = "{ "individuals": [ { ...} ], "entities": [ { ... } ], "documents": [ {...} ] }";

        // Open connection to the URL
        URL obj = new URL(url);
        HttpURLConnection con = (HttpURLConnection) obj.openConnection();
        con.setRequestMethod("POST");
        con.setRequestProperty("Content-Type", "application/json");
        con.setRequestProperty("Authorization", token);
        con.setDoOutput(true);

        // Send the JSON request body
        try (OutputStream os = con.getOutputStream()) {
            byte[] input = jsonInputString.getBytes("utf-8");
            os.write(input, 0, input.length);
        }

        // Get response code and output
        int responseCode = con.getResponseCode();
        System.out.println("Response Code: " + responseCode);
    }
}