kycgenie 1.0.2

Official Python SDK for the KYC Genie API.

KYCGenie Python SDK

Official Python SDK for the KYC Genie API. Automate KYC due diligence workflows - DDQs, AML screening, identity verification, and multi-bureau checks.

Requirements

Python 3.10+

Installation

pip install kycgenie

Authentication

All requests require an API key. Set it as an environment variable:

export KYCGENIE_API_KEY=your_api_key

Or pass it directly when initialising the client (not recommended for production):

from kycgenie import KYCGenie

client = KYCGenie(api_key="your_api_key")

Quick Start

from kycgenie import KYCGenie

client = KYCGenie(api_key="your_api_key")
# Create an entity
entity = client.entities.create(
    entity_type="company",
    legal_name="Acme Corp",
    email="[e-mail]",
)

print(f"Entity: {entity.name} - {entity.id}")

Test Mode

Use a test API key to run the full workflow against simulated data - no credits consumed, no external calls made. Test keys are available from your KYCGenie dashboard.

client = KYCGenie(api_key=os.getenv("KYCGENIE_TEST_API_KEY"))

Links

• API Documentation

Summary

KYC Genie API: KYC Genie v2 API. Use this schema to generate SDKs. For legacy v1 endpoints see the full schema.

Table of Contents

• KYCGenie Python SDK
  • Requirements
  • Installation
  • Authentication
  • Quick Start
  • Test Mode
  • Links
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • File uploads
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging

SDK Installation

[!TIP] To finish publishing your SDK to PyPI you must run your first generation action.

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add git+<UNSET>.git

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from kycgenie python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "kycgenie",
# ]
# ///

from kycgenie import KYCGenie

sdk = KYCGenie(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from kycgenie import KYCGenie
import os


with KYCGenie(
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:

    res = kyc_genie.account.get_api_key()

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from kycgenie import KYCGenie
import os

async def main():

    async with KYCGenie(
        api_key=os.getenv("KYCGENIE_API_KEY", ""),
    ) as kyc_genie:

        res = await kyc_genie.account.get_api_key_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
api_key	http	HTTP Bearer	KYCGENIE_API_KEY

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

from kycgenie import KYCGenie
import os


with KYCGenie(
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:

    res = kyc_genie.account.get_api_key()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

Account

• get_api_key - Get API Key Info
• get_credits - Get Credit Balance

Accounts

• get - Get Tenant Info

Comments

• list - List Comments
• create - Create Comment
• update - Update Comment
• delete - Delete Comment

CompanySearch

• execute - Search Companies
• get_details - Get Company Details

Documents

• list - List Documents
• get - Get Tenant Document
• delete - Delete Tenant Document
• get_download_url - Get Tenant Document Download URL
• upload_tenant_document - Upload Tenant Document
• get_file - Redeem Download Token

Entities

• list - List Entities
• create - Create Entity
• get - Get Entity Details
• update - Update Entity
• delete - Delete Entity
• list_documents - List Entity Documents
• upload_document - Upload Entity Document
• delete_document - Delete Entity Document
• get_document_download_url - Get Entity Document Download URL
• list_relationships - List Entity Relationships
• create_relationship - Create Entity Relationship
• update_relationship - Update Entity Relationship
• delete_relationship - Delete Entity Relationship
• get_client_report - Download Client Report
• batch_create - Batch Create Entities
• search - Search Entities

IdentityVerification

• list_entity_sessions - List Entity Verification Sessions
• create - Create Verification Session
• get_session - Get Verification Session Status
• resend - Resend Verification Link
• get_results - Get Verification Results (Detailed)
• list_session_reviews - List Verification Session Reviews
• create_review - Create Verification Review
• revoke_session - Revoke Verification Session
• list_sessions - List All Verification Sessions

NonDocumentChecks

• list - List Entity Non-Document Checks
• initiate - Initiate Multi-Bureau Check
• get_check - Get Multi-Bureau Check Status
• get_check_results - Get Multi-Bureau Check Results (Detailed)
• list_reviews - List Non-Document Check Reviews
• submit_review - Submit Multi-Bureau Check Review
• list_all - List All Non-Document Checks
• check_eligibility - Check Multi-Bureau Eligibility

QuestionnaireResponses

• list - List Questionnaire Responses
• create_response - Create Response
• get_details - Get response details
• delete - Delete Response
• get_answers - Get All Answers
• update_answers - Save Text Answers
• upload_file_answer - Upload File Answer
• list_file_answers - List File Answers
• get_file_answer - Get File Answer
• delete_file_answer - Delete File Answer
• download_file - Get File Download URL
• approve - Approve Response
• download_assessment - Download Assessment Report
• generate_assessment_report - Generate Assessment Report
• autofill - Trigger AI autofill for response
• check_answers - Check/validate response answers
• list_documents - List Response Documents
• get_entities - Get Response Entities
• list_notes - List Response Notes
• add_note - Add Response Note
• delete_note - Delete Response Note
• get_questions - Get Questions with Answer State
• reject - Reject Response
• request_changes - Request Changes
• screen_all - Screen All Response Entities
• send - Send PREFILL Response
• get_status - Get Response Status
• update_status - Update Response Status
• submit - Submit Response
• generate_token - Regenerate Submit Token
• batch_create - Batch Create Responses

QuestionnaireTemplates

• list - List Questionnaire Templates
• get_template - Get Questionnaire Template
• list_questions - Get Questionnaire Template Questions

Reports

• get_client_report - Download Client Report
• generate - Generate Client Report

RiskProfiles

• get_details - Get Risk Profile Details

Screening

• get_case - Get Case Details
• update_case - Update Case
• update_profile_status - Update Risk Profile Status
• update_status - Update Risk Profile Status
• screen - Screen Entity
• get - Get Screening Results (Summary)
• get_detailed - Get Screening Results (Detailed)
• update_monitoring - Update Ongoing Monitoring
• batch_screen - Batch Screen Entities
• get_batch_status - Get Batch Job Status

System

• get_health - Health Check

Tasks

• get_status - Get Task Status

Webhooks

• list_subscriptions - List Webhook Subscriptions
• create_subscription - Create Webhook
• get_details - Get Webhook
• update - Update Webhook
• delete - Delete Webhook
• rotate_secret - Rotate Webhook Secret
• get_config - Get Webhook Config
• update_config - Update Webhook Config
• delete_config - Delete Webhook Config
• list_logs - List Webhook Logs
• retry - Retry Webhook
• test_delivery - Test Webhook

Workflows

• send - Send Workflow (DDQ + Identity Verification)

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

from kycgenie import KYCGenie
import os


with KYCGenie(
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:

    res = kyc_genie.documents.upload_tenant_document(file={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    }, document_type="<value>")

    # Handle response
    print(res)

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from kycgenie import KYCGenie
from kycgenie.utils import BackoffStrategy, RetryConfig
import os


with KYCGenie(
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:

    res = kyc_genie.account.get_api_key(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from kycgenie import KYCGenie
from kycgenie.utils import BackoffStrategy, RetryConfig
import os


with KYCGenie(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:

    res = kyc_genie.account.get_api_key()

    # Handle response
    print(res)

Error Handling

KYCGenieError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

from kycgenie import KYCGenie, errors
import os


with KYCGenie(
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:
    res = None
    try:

        res = kyc_genie.account.get_api_key()

        # Handle response
        print(res)


    except errors.KYCGenieError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.KYCGenieAPIError):
            print(e.data.error)  # str
            print(e.data.code)  # str
            print(e.data.request_id)  # OptionalNullable[str]
            print(e.data.errors)  # OptionalNullable[Dict[str, List[str]]]
            print(e.data.details)  # OptionalNullable[Dict[str, Any]]

Error Classes

Primary errors:

• KYCGenieError: The base class for HTTP error responses.
  • KYCGenieAPIError: Standard error envelope returned by every 4xx/5xx response. *

Less common errors (5)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from KYCGenieError:

• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from kycgenie import KYCGenie
import os


with KYCGenie(
    server_url="https://api.kycgenie.com",
    api_key=os.getenv("KYCGENIE_API_KEY", ""),
) as kyc_genie:

    res = kyc_genie.account.get_api_key()

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from kycgenie import KYCGenie
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = KYCGenie(client=http_client)

or you could wrap the client with your own custom logic:

from kycgenie import KYCGenie
from kycgenie.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = KYCGenie(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The KYCGenie class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from kycgenie import KYCGenie
import os
def main():

    with KYCGenie(
        api_key=os.getenv("KYCGENIE_API_KEY", ""),
    ) as kyc_genie:
        # Rest of application here...


# Or when using async:
async def amain():

    async with KYCGenie(
        api_key=os.getenv("KYCGENIE_API_KEY", ""),
    ) as kyc_genie:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from kycgenie import KYCGenie
import logging

logging.basicConfig(level=logging.DEBUG)
s = KYCGenie(debug_logger=logging.getLogger("kycgenie"))

You can also enable a default debug logger by setting an environment variable KYCGENIE_DEBUG to true.