Modular API

Modular API Integration Guide

The Modular API provides a REST-based integration that enables full programmatic control over tenant workflows, including Document Processing, Identity verification, Banking Connectivity, and Forensic Analysis.

This page focuses exclusively on the API-based integration.

Refer to the Modular API documentation for a complete list of endpoints, request formats, and response schemas.

API Keys & Authentication

All Modular API interactions are scoped to an API Key. An API key represents your integration and acts as the root container for tenants, webhooks, and processing workflows.

• Create an API key for your application or environment.
• Each API key can manage multiple tenants.
• Webhooks are configured at the API key level and apply to all tenants created under that key.

API Reference

• Create API Key

Webhooks

Webhooks allow SKOR to notify your system about important events asynchronously.

Webhooks are configured per API key and deliver event notifications for all tenants associated with that key. These events allow your system to react accordingly when specific processes are completed.

• Document analysis completion events
• Clave processing success events
• KYC verification result events
• Forensic analysis completion events
• Financial analysis result events

API Reference

• Create Webhook

Tenant Management

Tenants are entities that you manage through APIs, allowing you to control and process their data across various workflows. Each tenant is associated with a specific API key.

Once a tenant is created, you can manage all subsequent actions such as Document uploads, Identity verification, Banking connections, and Forensic Analysis.

API Reference

• Create Tenant

Document Upload & Download

Documents can be uploaded for a tenant at any point after creation. Few Document examples are: Payslips, Bank Statements, Tax Returns, and Identity Documents.

Uploaded documents are stored in Skor Database and can be retrieved later when required.

• Upload documents for a tenant using the Documents API
• Trigger document analysis automatically upon successful upload
• Receive webhook events when document analysis is completed
• Download documents retrieved from Cl@ve

API Reference

• Upload Document
• Get Tenant Documents
• Get Document from Cl@ve

Identity Verification (KYC)

KYC verifies the tenant’s identity using official identity documents.

API Reference

• Start KYC

Financial Scoring (Bank Connectivity)

Banking data is analyzed and used in financial assessments.

API Reference

• Initiate Bank Connection

Forensic Analysis

Forensic analysis evaluates all available tenant data to detect Inconsistencies, Fraud Indicators, and Financial Risk signals.

Important: You do not need to manually trigger forensic analysis in most cases.

• Automatically runs when documents are uploaded
• Automatically runs after KYC completion
• Automatically runs after successful bank connectivity

You may still trigger it manually if required.

API Reference

• Run Forensic Analysis

End-to-End Flow Summary

1. Create an API key

   Generate an API key that will be used to authenticate all subsequent API requests. This key is required for accessing all protected endpoints and must be included in the request headers for tenant-related operations.

2. Configure webhooks for event notifications

   Configure webhooks to receive asynchronous notifications for key events such as Document analysis completion, Clave events, KYC completion, forensic analysis events and Financial analysis events. While optional, webhook configuration is strongly recommended to reliably track long-running processes.

3. Create tenants under the API key

   Create a tenant by providing their basic personal details. All the required fields are mentioned in endpoint documentation. Certainly, identification number and postcode are used to run Experian checks to assess defaulter and risk status.

4. Upload documents and/or download from Cl@ve

   Upload tenant documents either manually, via Cl@ve, or using a combination of both. Document submission is mandatory and acts as a blocking dependency for forensic analysis.

5. Initiate KYC verification

   Complete identity verification (KYC) for the tenant. KYC Verification is a mandatory, and Forensic analysis will not be triggered unless KYC has been successfully completed.

6. Connect your bank (Financial Scoring)

   Connect the tenant’s bank account. While optional, this step is recommended, as bank connectivity is required for Financial SKOR generation.

7. Consume results via APIs and webhooks

   Retrieve tenant operational data via APIs and consume asynchronous events delivered through webhooks.