KYB API
KYB API quick start
This section describes the minimum integration scenario: obtaining a KYB API key, creating a verification link for a business, and sending it to the company representative. The representative goes through the KYB flow on the KnowaKYC page; the result then arrives through a webhook or API.
Step 1. Get a KYB API key
In the API keys section of the admin panel:
- Click "Create key".
- Select type: KYB.
- Select environment: Production or Sandbox.
- Copy
api_key(formatkyb_live_...) andapi_secret. The secret is shown once — store it in a secure vault.
KYB keys are valid only for
/tenant/v1/kyb/*endpoints. KYC keys (kyc_live_*) cannot call the KYB API.
Step 2. Create a verification link
From your server, send a request to the Tenant KYB API (HMAC signing is mandatory — the scheme matches KYC, see Authentication):
POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Link options (flow_id required)
application/json- body
expires_in?integerseconds
external_reference?stringexternal_user_id?stringflow_id?stringlocale?stringmetadata?prefilled?redirect_url?stringutm_campaign?stringutm_medium?stringutm_source?stringCreated or reused link
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyb/verification-links' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "created_at": "string", "delivery_eligible": true, "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "id": "string", "link_url": "string", "locale": "string", "qr_code_url": "string", "redirect_url": "string", "reuse_reason": "external_reference", "reused": true, "session_id": "string", "session_resumable": true, "session_status": "string", "short_url": "string", "status": "string", "url": "string", "verification_link": "string", "verification_url": "string" }}Example request (JavaScript / Node.js):
const crypto = require("crypto");
const https = require("https");
const body = JSON.stringify({
flow_id: "your_kyb_flow_id",
external_user_id: "company-001",
expires_in: 259200, // 72 hours in seconds
locale: "en",
});
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyHash = crypto.createHash("sha256").update(body).digest("hex");
const stringToSign = `${timestamp}\nPOST\n/tenant/v1/kyb/verification-links\n${bodyHash}`;
const signature = crypto
.createHmac("sha256", "your_api_secret")
.update(stringToSign)
.digest("hex");
// Request headers
const headers = {
"Content-Type": "application/json",
"X-Timestamp": timestamp,
Authorization: `HMAC-SHA256 Credential=kyb_live_your_key, Signature=${signature}`,
};The response schema (id, url, status, expires_at, etc.) is described in the OpenAPI block above.
Send the url from the response to the company representative (by email, SMS, or as a QR code). Opening the link automatically creates a KYB session.
Step 3. The user completes the KYB flow
The company representative opens the link in a browser and works through the steps:
- Company data — name, registration number, country of registration.
- Executive and beneficial owner data — full name, ownership share.
- Document upload — charter, registration certificate.
- AI check — automated analysis (typical time — 2–3 minutes; the user sees a waiting screen).
Step 4. Receive the result
Through a webhook (recommended): configure the endpoint under Webhooks in the admin panel. KnowaKYC sends the kyb.business.verified, kyb.business.rejected, or kyb.business.review_required event.
Through the API: query the result by the external company identifier:
GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
external_id*stringYour external company/user ID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Company details
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses/external/string' \ -H 'X-Timestamp: string'Example Response
{ "data": { "activities": { "additional": [ "string" ], "main": "string" }, "activities_evidence_sources": [ "string" ], "activities_typed": [ { "code": "string", "description": "string", "is_primary": true, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "name": "string", "system": "string" } ], "activities_unavailable_reason_info": "string", "actual_address": "string", "additional_url": "string", "additional_url_evidence_sources": [ "string" ], "additional_url_unavailable_reason_info": "string", "addresses_typed": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "adverse_media": [ { "categories": [ "string" ], "language": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "published_at": "string", "severity": "string", "source": "string", "summary": "string", "title": "string", "url": "string" } ], "ai_analysis": { "confidence": 0, "confirmation_flag": true, "green_flags": [ "string" ], "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "model_version": "string", "red_flags": [ "string" ], "summary": "string" }, "ai_confirmation_flag": true, "ai_notes": "string", "ai_sources": [ "string" ], "ai_summary": "string", "bankruptcy": { "case_number": "string", "court": "string", "is_bankrupt": true, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "receiver": "string", "stage": "string", "started_at": "string" }, "beneficiaries": [ { "country": "string", "name": "string", "pep": true, "share": "string", "type": "string" } ], "beneficiaries_evidence_sources": [ "string" ], "beneficiaries_typed": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "beneficiaries_unavailable_reason_info": "string", "business_document_key": "string", "business_document_url": "string", "business_document_url_expires_at": "string", "company_name": "string", "company_status": "string", "country": "string", "created_at": "string", "current_review_decision": { "client_message": "string", "created_at": "string", "decision": "string", "id": "string", "reason_codes": [ "string" ], "scope": "string", "session_id": "string", "step_id": "string" }, "decision": "string", "director_evidence_sources": [ "string" ], "director_name": "string", "director_title": "string", "director_unavailable_reason_info": "string", "directors": [ { "name": "string", "title": "string" } ], "directors_typed": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "enrichment_errors": [ "string" ], "evidence_profile": { "property1": null, "property2": null }, "external_id": "string", "financials": { "assets": 0, "authorized_capital": 0, "currency": "string", "employee_count": 0, "employee_date": "string", "equity": 0, "fiscal_year": 0, "liabilities": 0, "net_profit": 0, "report_source": "string", "revenue": 0 }, "id": "string", "kyb": { "activities": [ { "code": "string", "description": "string", "is_primary": true } ], "activities_evidence_sources": [ "string" ], "activities_typed": [ { "code": "string", "description": "string", "is_primary": true, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "name": "string", "system": "string" } ], "activities_unavailable_reason_info": "string", "actual_address": "string", "additional_url": "string", "additional_url_evidence_sources": [ "string" ], "additional_url_unavailable_reason_info": "string", "addresses_typed": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "adverse_media": [ { "categories": [ "string" ], "language": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "published_at": "string", "severity": "string", "source": "string", "summary": "string", "title": "string", "url": "string" } ], "ai_analysis": { "confidence": 0, "confirmation_flag": true, "green_flags": [ "string" ], "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "model_version": "string", "red_flags": [ "string" ], "summary": "string" }, "bankruptcy": { "case_number": "string", "court": "string", "is_bankrupt": true, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "receiver": "string", "stage": "string", "started_at": "string" }, "beneficiaries": [ { "is_director": true, "name": "string", "ownership": 0 } ], "beneficiaries_evidence_sources": [ "string" ], "beneficiaries_typed": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "beneficiaries_unavailable_reason_info": "string", "company_aliases": [ "string" ], "company_code": "string", "company_name": "string", "confirmation_flag": true, "confirmation_tier": "string", "consulted_sources": [ "string" ], "country": "string", "decision": "string", "decision_reason": "string", "director_evidence_sources": [ "string" ], "director_name": "string", "director_title": "string", "director_unavailable_reason_info": "string", "directors_typed": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "field_evidence": [ { "confidence": 0, "declared_value": "string", "document_source": "string", "document_value": "string", "field": "string", "match_status": "string", "provider": "string", "provider_value": "string", "reason_code": "string", "severity": "string" } ], "financials": { "assets": 0, "authorized_capital": 0, "currency": "string", "employee_count": 0, "employee_date": "string", "equity": 0, "fiscal_year": 0, "liabilities": 0, "net_profit": 0, "report_source": "string", "revenue": 0 }, "incorporation_country": "string", "incorporation_date": "string", "legal_address": "string", "legal_form": "string", "legal_form_raw": "string", "lei": "string", "liquidation_date": "string", "litigation": [ { "amount": 0, "case_number": "string", "closed_at": "string", "court": "string", "currency": "string", "filed_at": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "role": "string", "status": "string", "subject": "string" } ], "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "lookup_coverage_tier": "string", "lookup_next_actions": [ { "action": "string", "detail": "string", "identifiers": [ "string" ], "label": "string", "provider": "string", "url": "string" } ], "lookup_outcome": { "auto_approval_eligible": true, "coverage_tier": "string", "decision_bias": "string", "next_actions": [ { "action": "string", "detail": "string", "identifiers": [ "string" ], "label": "string", "provider": "string", "url": "string" } ], "official_source_count": 0, "provider_statuses": [ { "detail": "string", "provider": "string", "status": "string" } ], "reason": "string", "registry_authority_hint": [ "string" ], "requires_manual_review": true, "secondary_source_count": 0 }, "lookup_outcome_reason": "string", "main_url": "string", "main_url_evidence_sources": [ "string" ], "main_url_unavailable_reason_info": "string", "notes": "string", "pep": [ { "confidence": 0, "hit_details": { "additional_information": [ { "label": "string", "value": "string" } ], "additional_sanctions": [ "string" ], "country": "string", "crypto_wallets": [ "string" ], "delisted_at": "string", "description": "string", "education": [ "string" ], "email_addresses": [ "string" ], "last_updated": "string", "listed_at": "string", "notes": "string", "phone_numbers": [ "string" ], "position": "string", "programs": [ "string" ], "remarks": "string", "risk_categories": [ "string" ], "source_links": [ "string" ], "source_url": "string", "websites": [ "string" ] }, "list_category": "string", "list_id": "string", "list_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_fields": [ "string" ], "match_strength": "string", "person": { "aliases": [ "string" ], "birth_place": "string", "citizenship": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "gender": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string" }, "provenance": { "raw_record": { "property1": null, "property2": null }, "vendor_list_id": "string", "vendor_match_id": "string", "vendor_source_id": "string" } } ], "proprietor_name": "string", "provider_metadata": { "duration_ms": 0, "evidence_reuse": { "execution_id": "string", "reason": "string", "recovery_audit_id": "string", "source_attempt_number": 0, "source_execution_id": "string", "source_verification_id": "string" }, "name": "string", "raw": { "property1": null, "property2": null }, "raw_response_key": "string", "received_at": "string", "request_id": "string", "version": "string" }, "provider_statuses": [ { "detail": "string", "provider": "string", "retrieved_at": "string", "status": "string" } ], "reconciliation_decision": "string", "reconciliation_reason_codes": [ "string" ], "registration_date": "string", "registration_number": "string", "registry_facts": [ { "company_aliases": [ "string" ], "company_name": "string", "confidence": 0, "country": "string", "director_names": [ "string" ], "incorporation_date": "string", "legal_address": "string", "lei": "string", "provider": "string", "registration_date": "string", "registration_number": "string", "source_retrieved_at": "string", "source_url": "string", "status": "string", "tax_number": "string", "website": "string" } ], "risk_factors": [ { "category": "string", "code": "string", "description": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "severity": "string", "weight": 0 } ], "risk_level": "string", "risk_score": 0, "sanctions": [ { "confidence": 0, "hit_details": { "additional_information": [ { "label": "string", "value": "string" } ], "additional_sanctions": [ "string" ], "country": "string", "crypto_wallets": [ "string" ], "delisted_at": "string", "description": "string", "education": [ "string" ], "email_addresses": [ "string" ], "last_updated": "string", "listed_at": "string", "notes": "string", "phone_numbers": [ "string" ], "position": "string", "programs": [ "string" ], "remarks": "string", "risk_categories": [ "string" ], "source_links": [ "string" ], "source_url": "string", "websites": [ "string" ] }, "list_category": "string", "list_id": "string", "list_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_fields": [ "string" ], "match_strength": "string", "person": { "aliases": [ "string" ], "birth_place": "string", "citizenship": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "gender": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string" }, "provenance": { "raw_record": { "property1": null, "property2": null }, "vendor_list_id": "string", "vendor_match_id": "string", "vendor_source_id": "string" } } ], "shareholders": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "signatories": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "sources": [ "string" ], "status": "string", "status_date": "string", "status_evidence_sources": [ "string" ], "status_info": "string", "summary": "string", "suspicious_signals": [ "string" ], "tax_number": "string", "trade_name": "string", "trading_name": "string" }, "kyb_document_analysis": { "confidence": 0, "decision": "string", "extracted_business_fields": { "actual_address": "string", "company_name": "string", "company_status": "string", "director_name": "string", "director_title": "string", "identifiers": [ "string" ], "legal_address": "string", "matched": [ "string" ], "missing": [ "string" ], "registration_date": "string", "registration_number": "string", "status_date": "string", "status_info": "string", "tax_number": "string" }, "files": [ { "document_group": "string", "document_type": "string", "encrypted": true, "freshness_status": "string", "issue_date": "string", "name": "string", "ocr_required": true, "size_bytes": 0, "text_bytes": 0, "type": "string" } ], "fraud_signals": [ { "file": "string", "type": "string" } ], "reasons": [ "string" ] }, "last_session_id": "string", "last_verified_at": "string", "latest_flow_name": "string", "legal_address": "string", "legal_form": "string", "liquidation_date": "string", "litigation": [ { "amount": 0, "case_number": "string", "closed_at": "string", "court": "string", "currency": "string", "filed_at": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "role": "string", "status": "string", "subject": "string" } ], "main_url": "string", "main_url_evidence_sources": [ "string" ], "main_url_unavailable_reason_info": "string", "pep": [ { "confidence": 0, "hit_details": { "additional_information": [ { "label": "string", "value": "string" } ], "additional_sanctions": [ "string" ], "country": "string", "crypto_wallets": [ "string" ], "delisted_at": "string", "description": "string", "education": [ "string" ], "email_addresses": [ "string" ], "last_updated": "string", "listed_at": "string", "notes": "string", "phone_numbers": [ "string" ], "position": "string", "programs": [ "string" ], "remarks": "string", "risk_categories": [ "string" ], "source_links": [ "string" ], "source_url": "string", "websites": [ "string" ] }, "list_category": "string", "list_id": "string", "list_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_fields": [ "string" ], "match_strength": "string", "person": { "aliases": [ "string" ], "birth_place": "string", "citizenship": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "gender": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string" }, "provenance": { "raw_record": { "property1": null, "property2": null }, "vendor_list_id": "string", "vendor_match_id": "string", "vendor_source_id": "string" } } ], "profile": { "property1": null, "property2": null }, "registration_date": "string", "registration_number": "string", "rejection_reasons": [ "string" ], "review_correction_at": "string", "review_requested_at": "string", "review_requested_by": "string", "review_risk_reasons": [ "string" ], "risk_factors": [ { "category": "string", "code": "string", "description": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "severity": "string", "weight": 0 } ], "risk_level": "string", "risk_score": 0, "sanctions": [ { "confidence": 0, "hit_details": { "additional_information": [ { "label": "string", "value": "string" } ], "additional_sanctions": [ "string" ], "country": "string", "crypto_wallets": [ "string" ], "delisted_at": "string", "description": "string", "education": [ "string" ], "email_addresses": [ "string" ], "last_updated": "string", "listed_at": "string", "notes": "string", "phone_numbers": [ "string" ], "position": "string", "programs": [ "string" ], "remarks": "string", "risk_categories": [ "string" ], "source_links": [ "string" ], "source_url": "string", "websites": [ "string" ] }, "list_category": "string", "list_id": "string", "list_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_fields": [ "string" ], "match_strength": "string", "person": { "aliases": [ "string" ], "birth_place": "string", "citizenship": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "gender": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string" }, "provenance": { "raw_record": { "property1": null, "property2": null }, "vendor_list_id": "string", "vendor_match_id": "string", "vendor_source_id": "string" } } ], "shareholders": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "signatories": [ { "addresses": [ { "address": { "city": "string", "country": "string", "full_text": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "postal_code": "string", "region": "string", "street": "string" }, "type": "string", "valid_from": "string", "valid_to": "string" } ], "appointed_at": "string", "date_of_birth": "string", "documents": [ { "class": "string", "country": "string", "expiration_date": "string", "issue_date": "string", "number": "string", "type": "string" } ], "first_name": "string", "full_name": "string", "id": "string", "is_pep": true, "is_sanctioned": true, "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "nationality": "string", "ownership_pct": 0, "resigned_at": "string", "role": "string", "role_raw": "string", "tax_id": "string" } ], "status_date": "string", "status_evidence_sources": [ "string" ], "status_info": "string", "tax_number": "string", "updated_at": "string", "verification_status": "string" }, "success": true}The response structure (success, data with company fields) is fully described in the Swagger specification — see the OpenAPI block above or the KYB API reference section.
Next steps
- KYB API reference — full endpoint list with parameters
- KYB webhooks — event types and payload formats
- Authentication — HMAC signature computation procedure