Tenant API (KYC)
API reference (OpenAPI)
The Tenant API specification is available in OpenAPI 3.0 format and contains the complete description of every endpoint, request, and response schema. The single specification covers both KYC endpoints (sessions, applicants, verification links, etc.) and KYB endpoints (/v1/kyb/businesses, /v1/kyb/businesses/{id}, etc.).
- OpenAPI 3.0 JSON: /tenant/docs/openapi3.json
- Interactive documentation (Swagger UI): /tenant/docs/
The topical sections of this documentation (Applicants, Verification links, Webhooks, etc.) embed the request and response blocks from the same specification. The complete endpoint list is below:
GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
external_id*stringExternal user ID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Documents list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/applicants/external/string/documents' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "attempt_number": 0, "collection": { "doc_liveness": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "doc_liveness_sides": { "property1": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "property2": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } } }, "document_metadata": { "back_file_id": "string", "front_file_id": "string", "portrait_file_id": "string", "primary_file_id": "string" }, "document_order": 0, "logical_document_id": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "review_decision": { "automatic_status": "string", "decided_at": "string", "decision": "string", "source": "string" }, "revision": 0, "status": "string" }, "created_at": "string", "extracted_data": { "date_of_birth": "string", "date_of_issue": "string", "document_number": "string", "document_type": "string", "expiry_date": "string", "extended_data": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "gender": "string", "issuing_country": "string", "last_name": "string", "middle_name": "string", "mrz": "string", "nationality": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "place_of_birth": "string" }, "id": "string", "is_current": true, "issuing_country": "string", "pages": [ { "download_url": "string", "download_url_expires_at": "string", "image_id": "string", "side": "string" } ], "reason_codes": [ "string" ], "session_id": "string", "side": "string", "status": "string", "step_id": "string", "type": "string", "verification": { "checks": [ { "is_authentic": true, "liveness_score": 0, "portrait_replace_score": 0, "printed_copy_score": 0, "rejection_reasons": [ "string" ], "screen_replay_score": 0, "similarity_score": 0, "status": "string", "type": "string" } ], "status": "string" } } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (default 1)
page_size?integerPage size (1-100, default 50)
action?stringFilter by action
actorId?stringFilter by actor UUID
dateFrom?stringFrom (RFC3339)
dateTo?stringTo (RFC3339)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Paged audit log items
*/*- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/audit' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "page": 0, "page_size": 0, "total_items": 0, "total_pages": 0 }, "success": true, "data": [ { "action": "string", "actor_email": "string", "actor_id": "string", "actor_type": "string", "created_at": "string", "details": { "changes": [ "string" ], "metadata": { "property1": null, "property2": null }, "new_value": { "property1": null, "property2": null }, "old_value": { "property1": null, "property2": null } }, "id": "string", "resource_id": "string", "resource_type": "string", "tenant_id": "string" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (1-based, default 1)
page_size?integerPage size (1-100, default 50)
status?stringFilter: pending, verified, rejected, review
country?stringFilter by country (ISO 3166-1 alpha-2)
search?stringSearch by company name or registration number
registration_number?stringFilter by registration number
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Paginated list of companies
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses' \ -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" } ], "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true}DELETE
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
business_id*stringBusiness UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Deletion request created
application/json- response
data?success?booleancurl -X DELETE 'https://example.com/tenant/v1/kyb/businesses/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "created_at": "string", "entity_type": "kyc", "id": "string", "object_id": "string", "object_type": "session", "reason": "string", "rejection_reason": "string", "requested_at": "string", "requested_by_id": "string", "requested_by_name": "string", "reviewed_at": "string", "reviewed_by_name": "string", "status": "pending", "tenant_id": "string", "updated_at": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
business_id*stringBusiness UUID
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/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}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
business_id*stringKnowaKYC business UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
All current company-document files
application/json- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses/string/documents' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "expires_at": "string", "group": "string", "key": "string", "session_id": "string", "step_id": "string", "url": "string" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
business_id*stringBusiness UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
History list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses/string/history' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "changed_by": "string", "details": { "property1": null, "property2": null }, "reason": "string", "status": "string", "timestamp": "string" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
business_id*stringBusiness UUID
page?integerPage (default 1)
page_size?integerPage size (1-100, default 20)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Sessions list with total
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses/string/sessions' \ -H 'X-Timestamp: string'Example Response
{ "data": { "page": 0, "page_size": 0, "sessions": [ { "completed_at": "string", "created_at": "string", "external_id": "string", "id": "string", "scope": "string", "status": "string" } ], "total": 0 }, "success": true}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}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)
Presigned document URL
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses/external/string/document' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "key": "string", "url": "string" }}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 ID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
All current company-document files
application/json- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/businesses/external/string/documents' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "expires_at": "string", "group": "string", "key": "string", "session_id": "string", "step_id": "string", "url": "string" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
media_id*stringMedia UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Presigned URL
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/media/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "created_at": "string", "download_url": "string", "download_url_expires_at": "string", "id": "string", "mime_type": "string", "size_bytes": 0, "type": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
limit?integerMax items (1-50, default 10)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Activity items
*/*- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/metrics/activity' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "id": "string", "message": "string", "metadata": { "property1": null, "property2": null }, "session_id": "string", "timestamp": "string", "type": "session_created" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Chart data
*/*- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/metrics/chart' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "approved": 0, "date": "string", "pending": 0, "rejected": 0, "total": 0 } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
CSV file
response?stringtext/csvcurl -X GET 'https://example.com/tenant/v1/kyb/metrics/export' \ -H 'X-Timestamp: string'Example Response
"string"GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Funnel steps
*/*- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/metrics/funnel' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "count": 0, "dropoff": 0, "label": "string", "percentage": 0, "step": 0 } ]}GET
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)
Realtime stats
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/metrics/realtime' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "active_sessions": 0, "average_time_last_hour": 0, "completed_last_hour": 0, "error_rate_last_hour": 0, "failed_last_hour": 0, "pending_review": 0, "sessions_last_hour": 0 }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m (default 30d)
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Stats
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/metrics/stats' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "approval_rate": 0, "approval_rate_change": 0, "avg_processing_time": 0, "avg_processing_time_change": 0, "completed_verifications": 0, "completed_verifications_change": 0, "pending_reviews": 0, "total_sessions": 0, "total_sessions_change": 0 }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (default 1)
page_size?integerPage size (1-100, default 50)
status?stringComma-separated statuses: pending,assigned,in_progress,awaiting_resubmit,approved,rejected,completed
priority?stringComma-separated priorities: low,medium,high,urgent
flow_id?stringFlow UUID
assigned_to?stringReviewer/API key UUID
session_id?stringSession UUID
q?stringSearch by external ID/company
date_from?stringFrom (RFC3339)
date_to?stringTo (RFC3339)
sla_status?stringSLA status: breached, warning, ok
sort?stringSort order: priority_desc, sla_asc, created_at_asc, created_at_desc
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "page": 0, "page_size": 0, "total_items": 0, "total_pages": 0 }, "success": true, "data": [ { "applicant_first_name": "string", "applicant_full_name": "string", "applicant_full_name_latin": "string", "applicant_full_name_native": "string", "applicant_full_name_original": "string", "applicant_id": "string", "applicant_last_name": "string", "applicant_middle_name": "string", "applicant_nationality": "string", "assigned_at": "string", "assigned_display_name": "string", "assigned_to": "string", "assigned_to_type": "string", "business_company_name": "string", "business_country": "string", "business_external_id": "string", "business_id": "string", "business_registration_number": "string", "business_tax_number": "string", "created_at": "string", "external_user_id": "string", "flow_id": "string", "flow_name": "string", "id": "string", "priority": 0, "reason": "string", "review_reasons": [ {} ], "reviewer_email": "string", "reviewer_first_name": "string", "reviewer_last_name": "string", "session_created_at": "string", "session_environment": "string", "session_id": "string", "sla_breached": true, "sla_deadline": "string", "started_at": "string", "status": "string", "system_decision": "string", "tenant_id": "string", "verification_result": "string", "verification_score": 0 } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "comments": [ { "author_display_name": "string", "author_id": "string", "author_type": "string", "content": "string", "created_at": "string", "id": "string", "task_id": "string" } ], "task": { "applicant_id": "string", "approval_blocked_reason": "string", "assigned_at": "string", "assigned_display_name": "string", "assigned_to": "string", "assigned_to_type": "string", "completed_at": "string", "created_at": "string", "decision": "string", "decision_at": "string", "decision_by": "string", "decision_by_type": "string", "decision_display_name": "string", "external_user_id": "string", "flow_id": "string", "flow_name": "string", "history": [ { "action": "string", "actor_id": "string", "actor_name": "string", "actor_type": "string", "created_at": "string", "details": { "property1": null, "property2": null }, "id": "string" } ], "id": "string", "notes": "string", "priority": 0, "reason": "string", "reason_details": "string", "reject_reason_code": "string", "resubmit_limit_override": 0, "review_reasons": [ {} ], "session_created_at": "string", "session_entity_type": "string", "session_environment": "string", "session_id": "string", "session_status": "string", "status": "string", "system_decision": "string", "tenant_id": "string" } }}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Optional comment and optimistic lock timestamp
application/json- body
comment?stringif_unmodified_since?stringOK
application/json- response
data?unknownsuccess?booleancurl -X POST 'https://example.com/tenant/v1/kyb/review-tasks/string/approve' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": null, "success": true}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?unknownsuccess?booleancurl -X POST 'https://example.com/tenant/v1/kyb/review-tasks/string/assign' \ -H 'X-Timestamp: string'Example Response
{ "data": null, "success": true}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks/string/comments' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "author_display_name": "string", "author_id": "string", "author_type": "string", "content": "string", "created_at": "string", "id": "string", "task_id": "string" } ]}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Comment payload
application/json- body
content?stringContent is the comment text (required, non-empty after trim).
OK
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyb/review-tasks/string/comments' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "author_display_name": "string", "author_id": "string", "author_type": "string", "comment_id": "string", "content": "string", "created_at": "string", "message": "string", "task_id": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
document_id*stringDocument ID or storage key suffix
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?unknownsuccess?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks/string/documents/string/url' \ -H 'X-Timestamp: string'Example Response
{ "data": null, "success": true}PATCH
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Priority payload
application/json- body
priority?stringOK
application/json- response
data?unknownsuccess?booleancurl -X PATCH 'https://example.com/tenant/v1/kyb/review-tasks/string/priority' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": null, "success": true}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Reject payload
application/json- body
comment?stringif_unmodified_since?stringreason_code?stringOK
application/json- response
data?unknownsuccess?booleancurl -X POST 'https://example.com/tenant/v1/kyb/review-tasks/string/reject' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": null, "success": true}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Resubmit payload
application/json- body
client_message?stringinternal_notes?stringreason_code?stringrequest_id?stringscope?stringstep_id?stringOK
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyb/review-tasks/string/request-resubmit' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "clientMessage": "string", "createdAt": "string", "deliveredAt": "string", "deliveryChannel": "string", "expiresAt": "string", "fulfilledAt": "string", "id": "string", "internalNotes": "string", "reasonCode": "string", "requestedBy": "string", "requestedByDisplayName": "string", "requestedByType": "string", "scope": "string", "sessionID": "string", "status": "string", "stepID": "string", "taskID": "string", "tenantID": "string", "updatedAt": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks/string/resubmits' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "clientMessage": "string", "createdAt": "string", "deliveredAt": "string", "deliveryChannel": "string", "expiresAt": "string", "fulfilledAt": "string", "id": "string", "internalNotes": "string", "reasonCode": "string", "requestedBy": "string", "requestedByDisplayName": "string", "requestedByType": "string", "scope": "string", "sessionID": "string", "status": "string", "stepID": "string", "taskID": "string", "tenantID": "string", "updatedAt": "string" } ]}GET
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)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks/reject-reasons' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "category": "string", "code": "string", "label_en": "string", "label_ru": "string" } ]}GET
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)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/review-tasks/stats' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "avg_time_minutes": 0, "completed_today": 0, "in_progress": 0, "pending": 0 }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (1-based)
page_size?integerPage size (1-100)
status?stringFilter by status (active, consumed, revoked)
external_user_id?stringFilter by external user ID
external_reference?stringFilter by external reference
flow_id?stringFilter by flow UUID
sort_by?stringSort field (default created_at)
sort_order?stringSort order: asc, desc (default desc)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Verification links
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/verification-links' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "items": [ { "activated_at": "string", "consumed_at": "string", "created_at": "string", "created_by": "string", "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "flow_session_id": "string", "id": "string", "locale": "string", "metadata": { "property1": null, "property2": null }, "prefilled_data": { "property1": null, "property2": null }, "redirect_url": "string", "revoked_at": "string", "revoked_reason": "string", "short_code": "string", "status": "string", "token": "string", "updated_at": "string", "utm_campaign": "string", "utm_medium": "string", "utm_source": "string" } ], "pagination": { "page": 0, "page_size": 0, "total": 0, "total_pages": 0 } }}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" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Verification link details
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyb/verification-links/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "activated_at": "string", "consumed_at": "string", "created_at": "string", "created_by": "string", "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "flow_session_id": "string", "id": "string", "locale": "string", "metadata": { "property1": null, "property2": null }, "prefilled_data": { "property1": null, "property2": null }, "redirect_url": "string", "revoked_at": "string", "revoked_reason": "string", "short_code": "string", "status": "string", "token": "string", "updated_at": "string", "utm_campaign": "string", "utm_medium": "string", "utm_source": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
size?integerQR size in pixels (1-1024, default 256)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
PNG image
response?unknownimage/pngcurl -X GET 'https://example.com/tenant/v1/kyb/verification-links/string/qr' \ -H 'X-Timestamp: string'Example Response
nullPOST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Optional revoke reason
application/json- body
reason?stringRevoked link info
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyb/verification-links/string/revoke' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "id": "string", "revoked_at": "string", "status": "string" }}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)
Batch create request
application/json- body
defaults?items?array<>Created links
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyb/verification-links/batch' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "failed": [ { "error": "string", "error_code": "string", "existing_session_id": "string", "index": 0, "link": { "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" } } ], "successful": [ { "error": "string", "error_code": "string", "existing_session_id": "string", "index": 0, "link": { "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" } } ], "summary": { "failed": 0, "successful": 0, "total": 0 } }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
limit?integerLimit (1-100, default 50)
offset?integerOffset (default 0)
status?stringFilter by verification status
Value in
"pending""verified""rejected""review"X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Applicants list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "address": "string", "aml_decision": "string", "aml_risk_score": 0, "avatar_photo_url": "string", "avatar_url": "string", "client_liveness_score": 0, "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" }, "date_of_birth": "string", "details": { "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" }, "barcode": { "fields": { "property1": "string", "property2": "string" }, "raw": "string", "type": "string" }, "document": { "booklet_number": "string", "class": "string", "issuing_authority": "string", "issuing_place": "string", "issuing_state_code": "string", "mrz_type": "string", "series": "string" }, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "mrz": { "document_code": "string", "fields": { "property1": "string", "property2": "string" }, "issuing_state": "string", "raw": "string" }, "personal": { "additional_fields": { "property1": "string", "property2": "string" }, "nationality_name": "string", "personal_number": "string", "profession": "string", "tax_number": "string" }, "provider": { "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" } }, "doc_liveness_score": 0, "document_back_key": "string", "document_back_url": "string", "document_front_key": "string", "document_front_url": "string", "document_number": "string", "document_photo_key": "string", "document_photo_url": "string", "document_type": "string", "email": "string", "enrichment": { "scope": "string", "summary": { "bankruptcy_confirmed": true, "call_statuses": { "property1": "string", "property2": "string" }, "completed_at": "string", "hard_block_reason": "string", "match_count": 0, "merged_decision": "string", "merged_risk_score": 0, "observed_at": "string", "passport_invalid": true, "status": "string" } }, "enrichment_errors": [ "string" ], "expiry_date": "string", "expiry_status": "string", "external_id": "string", "face_match_score": 0, "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "id": "string", "issuing_country": "string", "issuing_state_code": "string", "last_name": "string", "last_session_id": "string", "last_verified_at": "string", "latest_flow_name": "string", "liveness_mode": "string", "liveness_score": 0, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "name_source": { "property1": null, "property2": null }, "nationality": "string", "phone": "string", "photo_url_expires_at": "string", "portrait_photo_key": "string", "portrait_photo_url": "string", "risk_score": 0, "risk_signals": { "property1": null, "property2": null }, "selfie_photo_key": "string", "selfie_photo_url": "string", "session_summary": { "approved": 0, "in_progress": 0, "rejected": 0, "review": 0, "total": 0 }, "updated_at": "string", "verification_score": 0, "verification_status": "pending" } ]}DELETE
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Deletion request created
application/json- response
data?success?booleancurl -X DELETE 'https://example.com/tenant/v1/kyc/applicants/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "created_at": "string", "entity_type": "kyc", "id": "string", "object_id": "string", "object_type": "session", "reason": "string", "rejection_reason": "string", "requested_at": "string", "requested_by_id": "string", "requested_by_name": "string", "reviewed_at": "string", "reviewed_by_name": "string", "status": "pending", "tenant_id": "string", "updated_at": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
detailed?booleanInclude document recognition, personal info and sessions (default false)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Applicant profile; detailed fields are included only with detailed=true
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "address": "string", "aml_decision": "string", "aml_risk_score": 0, "avatar_photo_url": "string", "avatar_url": "string", "client_liveness_score": 0, "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" }, "date_of_birth": "string", "details": { "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" }, "barcode": { "fields": { "property1": "string", "property2": "string" }, "raw": "string", "type": "string" }, "document": { "booklet_number": "string", "class": "string", "issuing_authority": "string", "issuing_place": "string", "issuing_state_code": "string", "mrz_type": "string", "series": "string" }, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "mrz": { "document_code": "string", "fields": { "property1": "string", "property2": "string" }, "issuing_state": "string", "raw": "string" }, "personal": { "additional_fields": { "property1": "string", "property2": "string" }, "nationality_name": "string", "personal_number": "string", "profession": "string", "tax_number": "string" }, "provider": { "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" } }, "doc_liveness_score": 0, "document_back_key": "string", "document_back_url": "string", "document_details": { "additional_fields": { "property1": "string", "property2": "string" }, "address": "string", "authority_code": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "date_of_expiry": "string", "date_of_issue": "string", "document_class_code": "string", "document_number": "string", "document_series": "string", "document_type": "string", "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "gender": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_state_code": "string", "last_name": "string", "localized_fields": { "property1": "string", "property2": "string" }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "personal_number": "string", "place_of_birth": "string", "place_of_issue": "string", "profession": "string", "tax_number": "string" }, "document_front_key": "string", "document_front_url": "string", "document_number": "string", "document_photo_key": "string", "document_photo_url": "string", "document_type": "string", "email": "string", "enrichment": { "scope": "string", "summary": { "bankruptcy_confirmed": true, "call_statuses": { "property1": "string", "property2": "string" }, "completed_at": "string", "hard_block_reason": "string", "match_count": 0, "merged_decision": "string", "merged_risk_score": 0, "observed_at": "string", "passport_invalid": true, "status": "string" } }, "enrichment_errors": [ "string" ], "expiry_date": "string", "expiry_status": "string", "external_id": "string", "face_match_score": 0, "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "id": "string", "identity_projection": { "document_type": "string", "field_sources": { "property1": [ { "document_id": "string", "revision": 0 } ], "property2": [ { "document_id": "string", "revision": 0 } ] }, "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" } }, "issuing_country": "string", "issuing_state_code": "string", "last_name": "string", "last_session_id": "string", "last_verified_at": "string", "latest_flow_name": "string", "liveness_mode": "string", "liveness_score": 0, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "name_source": { "property1": null, "property2": null }, "nationality": "string", "personal_info": { "address": { "city": "string", "country": "string", "postal_code": "string", "state": "string", "street": "string" }, "date_of_birth": "string", "email": "string", "first_name": "string", "gender": "string", "last_name": "string", "middle_name": "string", "nationality": "string", "ocr_full_name_latin": "string", "ocr_full_name_native": "string", "phone": "string" }, "phone": "string", "photo_url_expires_at": "string", "portrait_photo_key": "string", "portrait_photo_url": "string", "risk_score": 0, "risk_signals": { "property1": null, "property2": null }, "selfie_photo_key": "string", "selfie_photo_url": "string", "session_summary": { "approved": 0, "in_progress": 0, "rejected": 0, "review": 0, "total": 0 }, "sessions": [ { "applicant_id": "string", "completed_at": "string", "context": { "property1": null, "property2": null }, "created_at": "string", "current_step_id": "string", "decision_reasons": [ { "actor": { "display_name": "string", "email": "string", "id": "string", "role": "string", "type": "string" }, "category": "string", "code": "string", "created_at": "string", "details": { "property1": null, "property2": null }, "id": "string", "message": "string", "severity": "string", "source": "string", "step_execution_id": "string", "superseded_at": "string", "superseded_by": "string" } ], "device_info": { "browser_name": "string", "browser_version": "string", "country_code": "string", "device_type": "string", "fingerprint_request_id": "string", "fp_collection_failed": true, "os": "string", "os_version": "string", "timezone": "string", "user_agent": "string" }, "expires_at": "string", "external_id": "string", "fingerprint_visitor_id": "string", "flow_id": "string", "flow_version": 0, "id": "string", "ip_address": "string", "locale": "string", "risk_signals": { "property1": null, "property2": null }, "started_at": "string", "status": "pending", "steps_completed": 0, "user_agent": "string", "verification_link_id": "string", "verification_result": "string", "verification_score": 0 } ], "tenant_id": "string", "updated_at": "string", "verification_score": 0, "verification_status": "pending" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/string/aml' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "aml": { "aml_screening_completed": true, "aml_screening_status": "string", "aml_service_unavailable": true, "checks": { "property1": "string", "property2": "string" }, "checks_typed": [ { "checked_at": "string", "hit_count": 0, "list_id": "string", "list_name": "string", "status": "string" } ], "compliance": { "bankruptcy": { "address": "string", "bankrupt_date": "string", "matched_inn": "string", "snils": "string", "stage": "string", "stage_date": "string" }, "passport": { "invalid_since": "string", "is_invalid": true, "passport_number": "string" }, "rkl": { "document_number": "string", "in_registry": true } }, "decision": "string", "effective_list_actions": { "property1": "string", "property2": "string" }, "effective_match_policy": { "match_strength": "string", "match_strength_per_list": { "property1": "string", "property2": "string" }, "min_match_confidence": 0 }, "error_code": "string", "error_message": "string", "forced_review_reason": "string", "input_fields_used": [ "string" ], "lists_checked": [ "string" ], "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_details": [ { "property1": null, "property2": null } ], "match_found": true, "match_severity": "string", "matched_lists": [ "string" ], "matches": [ { "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" } } ], "provider": "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" }, "providers_called": [ "string" ], "providers_errored": [ "string" ], "providers_succeeded": [ "string" ], "risk_score": 0, "unchecked_lists": [ "string" ] }, "aml_provider_info": { "forced_review_reason": "string", "providers_called": [ "string" ], "providers_errored": [ "string" ], "providers_succeeded": [ "string" ], "service_unavailable": true, "unchecked_lists": [ "string" ] }, "aml_screening_completed": true, "aml_screening_status": "string", "applicant_id": "string", "attempt_number": 0, "checks": { "property1": "string", "property2": "string" }, "checks_typed": [ { "checked_at": "string", "hit_count": 0, "list_id": "string", "list_name": "string", "status": "string" } ], "decision": "string", "error_code": "string", "error_message": "string", "hits": [ { "decision": "string", "list_type": "string", "status": "string" } ], "lists_checked": [ "string" ], "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_details": [ { "property1": null, "property2": null } ], "match_severity": "string", "matched_lists": [ "string" ], "matches": [ { "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" } } ], "provider": "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" }, "risk_score": 0, "screened_at": "string", "session_id": "string", "status": "string", "step_id": "string", "summary": { "property1": 0, "property2": 0 }, "verification_id": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Documents list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/string/documents' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "attempt_number": 0, "collection": { "doc_liveness": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "doc_liveness_sides": { "property1": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "property2": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } } }, "document_metadata": { "back_file_id": "string", "front_file_id": "string", "portrait_file_id": "string", "primary_file_id": "string" }, "document_order": 0, "logical_document_id": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "review_decision": { "automatic_status": "string", "decided_at": "string", "decision": "string", "source": "string" }, "revision": 0, "status": "string" }, "created_at": "string", "extracted_data": { "date_of_birth": "string", "date_of_issue": "string", "document_number": "string", "document_type": "string", "expiry_date": "string", "extended_data": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "gender": "string", "issuing_country": "string", "last_name": "string", "middle_name": "string", "mrz": "string", "nationality": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "place_of_birth": "string" }, "id": "string", "is_current": true, "issuing_country": "string", "pages": [ { "download_url": "string", "download_url_expires_at": "string", "image_id": "string", "side": "string" } ], "reason_codes": [ "string" ], "session_id": "string", "side": "string", "status": "string", "step_id": "string", "type": "string", "verification": { "checks": [ { "is_authentic": true, "liveness_score": 0, "portrait_replace_score": 0, "printed_copy_score": 0, "rejection_reasons": [ "string" ], "screen_replay_score": 0, "similarity_score": 0, "status": "string", "type": "string" } ], "status": "string" } } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
History list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/string/history' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "changed_by": "string", "details": { "property1": null, "property2": null }, "previous_status": "string", "reason": "string", "status": "string", "timestamp": "string" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Sessions list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/string/sessions' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "applicant_id": "string", "completed_at": "string", "context": { "property1": null, "property2": null }, "created_at": "string", "current_step_id": "string", "decision_reasons": [ { "actor": { "display_name": "string", "email": "string", "id": "string", "role": "string", "type": "string" }, "category": "string", "code": "string", "created_at": "string", "details": { "property1": null, "property2": null }, "id": "string", "message": "string", "severity": "string", "source": "string", "step_execution_id": "string", "superseded_at": "string", "superseded_by": "string" } ], "device_info": { "browser_name": "string", "browser_version": "string", "country_code": "string", "device_type": "string", "fingerprint_request_id": "string", "fp_collection_failed": true, "os": "string", "os_version": "string", "timezone": "string", "user_agent": "string" }, "expires_at": "string", "external_id": "string", "fingerprint_visitor_id": "string", "flow_id": "string", "flow_version": 0, "id": "string", "ip_address": "string", "locale": "string", "risk_signals": { "property1": null, "property2": null }, "started_at": "string", "status": "pending", "steps_completed": 0, "user_agent": "string", "verification_link_id": "string", "verification_result": "string", "verification_score": 0 } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
applicant_id*stringApplicant UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/string/verification' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "applicant_id": "string", "checks": [ { "aml": { "aml_screening_completed": true, "aml_screening_status": "string", "aml_service_unavailable": true, "checks": { "property1": "string", "property2": "string" }, "checks_typed": [ { "checked_at": "string", "hit_count": 0, "list_id": "string", "list_name": "string", "status": "string" } ], "compliance": { "bankruptcy": { "address": "string", "bankrupt_date": "string", "matched_inn": "string", "snils": "string", "stage": "string", "stage_date": "string" }, "passport": { "invalid_since": "string", "is_invalid": true, "passport_number": "string" }, "rkl": { "document_number": "string", "in_registry": true } }, "decision": "string", "effective_list_actions": { "property1": "string", "property2": "string" }, "effective_match_policy": { "match_strength": "string", "match_strength_per_list": { "property1": "string", "property2": "string" }, "min_match_confidence": 0 }, "error_code": "string", "error_message": "string", "forced_review_reason": "string", "input_fields_used": [ "string" ], "lists_checked": [ "string" ], "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "match_details": [ { "property1": null, "property2": null } ], "match_found": true, "match_severity": "string", "matched_lists": [ "string" ], "matches": [ { "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" } } ], "provider": "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" }, "providers_called": [ "string" ], "providers_errored": [ "string" ], "providers_succeeded": [ "string" ], "risk_score": 0, "unchecked_lists": [ "string" ] }, "attempt_number": 0, "completed_at": "string", "doc_liveness": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "face_liveness": { "face_warnings": [ "string" ], "faces": [ { "eye_dist": 0, "face_luminance": 0, "face_occlusion": 0, "face_quality": 0, "landmark_68": [ { "x": 0, "y": 0 } ], "left_eye_closed": 0, "mouth_opened": 0, "pitch": 0, "right_eye_closed": 0, "roll": 0, "state": { "eye_closed": true, "has_mouth_open": true, "has_occlusion": true, "is_boundary_face": true, "is_front": true, "is_not_front": true, "is_small": true, "luminance": "string", "quality": "string", "result": "string" }, "x1": 0, "x2": 0, "y1": 0, "y2": 0, "yaw": 0 } ], "is_live": true, "message": "string", "quality": 0, "quality_warning_reason": "string", "score": 0, "status": "string", "threshold": 0 }, "face_match": { "confidence_level": "string", "face1_index": 0, "face2_index": 0, "faces1": [ { "eye_dist": 0, "face_luminance": 0, "face_occlusion": 0, "face_quality": 0, "landmark_68": [ { "x": 0, "y": 0 } ], "left_eye_closed": 0, "mouth_opened": 0, "pitch": 0, "right_eye_closed": 0, "roll": 0, "state": { "eye_closed": true, "has_mouth_open": true, "has_occlusion": true, "is_boundary_face": true, "is_front": true, "is_not_front": true, "is_small": true, "luminance": "string", "quality": "string", "result": "string" }, "x1": 0, "x2": 0, "y1": 0, "y2": 0, "yaw": 0 } ], "faces2": [ { "eye_dist": 0, "face_luminance": 0, "face_occlusion": 0, "face_quality": 0, "landmark_68": [ { "x": 0, "y": 0 } ], "left_eye_closed": 0, "mouth_opened": 0, "pitch": 0, "right_eye_closed": 0, "roll": 0, "state": { "eye_closed": true, "has_mouth_open": true, "has_occlusion": true, "is_boundary_face": true, "is_front": true, "is_not_front": true, "is_small": true, "luminance": "string", "quality": "string", "result": "string" }, "x1": 0, "x2": 0, "y1": 0, "y2": 0, "yaw": 0 } ], "is_match": true, "result_code": "string", "score": 0, "threshold": 0 }, "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" }, "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "proof_of_address": { "address_apartment_present": true, "address_building_present": true, "address_city": "string", "address_country": "string", "address_display": "string", "address_line1_present": true, "address_line2_present": true, "address_postal_code": "string", "address_source": "string", "address_street_present": true, "address_subdivision": "string", "applicant_message_code": "string", "blocked_keyword_count": 0, "config_source": "string", "config_version": 0, "decision": "string", "document_address_geocode_components": [ { "evidence_present": true, "expected_value": "string", "field": "string", "matched": true, "matched_token": "string", "normalized_expected": "string", "normalized_observed": "string", "observed_confidence": 0, "observed_source": "string", "observed_value": "string", "required": true, "weight": 0 } ], "document_address_geocode_confidence_bucket": "string", "document_address_geocode_distance_bucket": "string", "document_address_geocode_expected_display": "string", "document_address_geocode_observed_display": "string", "document_address_geocode_score_bucket": "string", "document_address_geocode_status": "string", "document_address_match_components": [ { "evidence_present": true, "expected_value": "string", "field": "string", "matched": true, "matched_token": "string", "normalized_expected": "string", "normalized_observed": "string", "observed_confidence": 0, "observed_source": "string", "observed_value": "string", "required": true, "weight": 0 } ], "document_address_match_score_bucket": "string", "document_address_match_status": "string", "document_address_matched": true, "document_available": true, "document_category": "string", "document_classification_accepted": true, "document_classification_category": "string", "document_classification_confidence_bucket": "string", "document_classification_negative_signals": "string", "document_classification_positive_signals": "string", "document_classification_status": "string", "document_classification_subtype": "string", "document_country": "string", "document_language": "string", "document_ocr_confidence_bucket": "string", "document_ocr_degraded": true, "document_ocr_extracted_bytes": 0, "document_ocr_text_snippet": "string", "document_ocr_text_truncated": true, "document_page_count": 0, "document_screenshot": true, "document_subtype": "string", "document_unsupported_reason": "string", "fingerprint_state": "string", "gps_accuracy_meters": 0, "gps_address_distance_bucket": "string", "gps_address_distance_meters": 0, "gps_address_match_radius_meters": 0, "gps_address_mismatch_radius_meters": 0, "gps_address_proximity_status": "string", "gps_country": "string", "gps_geocode_confidence_bucket": "string", "gps_signal_status": "string", "ip_accuracy_radius_bucket": "string", "ip_connection_type": "string", "ip_country": "string", "ip_country_confidence_bucket": "string", "ip_expected": "string", "ip_signal_status": "string", "reason_codes": [ "string" ], "reviewer_summary": "string", "route": "string" }, "rejection_reasons": [ "string" ], "score": 0, "status": "string", "step_id": "string", "type": "string", "verification_id": "string" } ], "completed_at": "string", "custom_steps": [ { "config": { "fields": [ { "data_type": "string", "id": "string", "label": "string", "max_length": 0, "min_length": 0, "required": true, "validation_preset": "string" } ], "lists": [ { "black_list_items_count": 0, "display": "string", "grey_list_items_count": 0, "id": "string", "label": "string", "multiple": true, "required": true, "selected_value_ids": [ "string" ], "value_policy": "string", "values_count": 0 } ], "mode": "string" }, "decision": { "action": "string", "code": "string", "list_id": "string", "list_label": "string", "match_type": "string", "status": "string" }, "execution_id": "string", "fields": [ { "key": "string", "label": "string", "value": "string" } ], "lists": [ { "key": "string", "label": "string", "values": [ { "id": "string", "label": "string" } ] } ], "step_id": "string", "step_key": "string", "step_name": "string" } ], "email": "string", "phone": "string", "risk_score": 0, "session_id": "string", "status": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
external_id*stringExternal user ID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/external/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "address": "string", "aml_decision": "string", "aml_risk_score": 0, "avatar_photo_url": "string", "avatar_url": "string", "client_liveness_score": 0, "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" }, "date_of_birth": "string", "details": { "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" }, "barcode": { "fields": { "property1": "string", "property2": "string" }, "raw": "string", "type": "string" }, "document": { "booklet_number": "string", "class": "string", "issuing_authority": "string", "issuing_place": "string", "issuing_state_code": "string", "mrz_type": "string", "series": "string" }, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "mrz": { "document_code": "string", "fields": { "property1": "string", "property2": "string" }, "issuing_state": "string", "raw": "string" }, "personal": { "additional_fields": { "property1": "string", "property2": "string" }, "nationality_name": "string", "personal_number": "string", "profession": "string", "tax_number": "string" }, "provider": { "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" } }, "doc_liveness_score": 0, "document_back_key": "string", "document_back_url": "string", "document_front_key": "string", "document_front_url": "string", "document_number": "string", "document_photo_key": "string", "document_photo_url": "string", "document_type": "string", "email": "string", "enrichment": { "scope": "string", "summary": { "bankruptcy_confirmed": true, "call_statuses": { "property1": "string", "property2": "string" }, "completed_at": "string", "hard_block_reason": "string", "match_count": 0, "merged_decision": "string", "merged_risk_score": 0, "observed_at": "string", "passport_invalid": true, "status": "string" } }, "enrichment_errors": [ "string" ], "expiry_date": "string", "expiry_status": "string", "external_id": "string", "face_match_score": 0, "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "id": "string", "issuing_country": "string", "issuing_state_code": "string", "last_name": "string", "last_session_id": "string", "last_verified_at": "string", "latest_flow_name": "string", "liveness_mode": "string", "liveness_score": 0, "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "name_source": { "property1": null, "property2": null }, "nationality": "string", "phone": "string", "photo_url_expires_at": "string", "portrait_photo_key": "string", "portrait_photo_url": "string", "risk_score": 0, "risk_signals": { "property1": null, "property2": null }, "selfie_photo_key": "string", "selfie_photo_url": "string", "session_summary": { "approved": 0, "in_progress": 0, "rejected": 0, "review": 0, "total": 0 }, "updated_at": "string", "verification_score": 0, "verification_status": "pending" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
external_id*stringExternal user ID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Documents list
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/applicants/external/string/documents' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "attempt_number": 0, "collection": { "doc_liveness": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "doc_liveness_sides": { "property1": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } }, "property2": { "is_real": true, "portrait_replace": 0, "printed_copy": 0, "result_code": "string", "score": 0, "screen_replay": 0, "status": "string", "status_error": "string", "thresholds": { "portrait_replace": 0, "printed_copy": 0, "screen_replay": 0 } } }, "document_metadata": { "back_file_id": "string", "front_file_id": "string", "portrait_file_id": "string", "primary_file_id": "string" }, "document_order": 0, "logical_document_id": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "review_decision": { "automatic_status": "string", "decided_at": "string", "decision": "string", "source": "string" }, "revision": 0, "status": "string" }, "created_at": "string", "extracted_data": { "date_of_birth": "string", "date_of_issue": "string", "document_number": "string", "document_type": "string", "expiry_date": "string", "extended_data": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "full_name_native": "string", "full_name_original": "string", "gender": "string", "issuing_country": "string", "last_name": "string", "middle_name": "string", "mrz": "string", "nationality": "string", "ocr": { "additional": { "property1": "string", "property2": "string" }, "address": "string", "barcode": { "property1": "string", "property2": "string" }, "booklet_number": "string", "date_of_birth": "string", "document_class": "string", "document_name": "string", "document_number": "string", "document_series": "string", "document_type": "string", "expiry_date": "string", "field_issues": { "property1": "string", "property2": "string" }, "first_name": "string", "full_name": "string", "full_name_latin": "string", "gender": "string", "issue_date": "string", "issuing_authority": "string", "issuing_authority_name": "string", "issuing_country": "string", "issuing_place": "string", "issuing_state_code": "string", "last_name": "string", "localized": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "middle_name": "string", "mrz_code": "string", "mrz_data": { "property1": "string", "property2": "string" }, "mrz_type": "string", "nationality": "string", "nationality_name": "string", "native_full_name": "string", "personal_number": "string", "place_of_birth": "string", "portrait": "string", "portrait_position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "position": { "x1": 0, "x2": 0, "y1": 0, "y2": 0 }, "profession": "string", "reconciliation": { "canonical_name": { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" }, "confidence": 0, "conflicts": [ { "code": "name_mismatch", "field": "string", "left_source": "mrz", "right_source": "mrz", "severity": "string" } ], "decision": "accept", "evidence_sufficient": true, "fixable_by_recapture": true, "model": "string", "mrz": { "decision_source": "string", "independent_available": true, "independent_valid": true, "parsed": { "checks": { "property1": { "expected": "string", "observed": "string", "valid": true }, "property2": { "expected": "string", "observed": "string", "valid": true } }, "date_of_birth": "string", "document_number": "string", "expiry_date": "string", "given_names": "string", "layout": "TD1", "nationality": "string", "raw_lines": [ "string" ], "sex": "string", "surname": "string", "valid": true, "validation_complete": true }, "provider_state": "valid", "provider_validation": "string", "shadow_decision_applied": true, "shadow_state": "valid" }, "names": [ { "confidence": 0, "full_name": "string", "given_names": "string", "language": "string", "script": "string", "source": "mrz", "surname": "string" } ], "recommended_action": "continue" }, "tax_number": "string" }, "place_of_birth": "string" }, "id": "string", "is_current": true, "issuing_country": "string", "pages": [ { "download_url": "string", "download_url_expires_at": "string", "image_id": "string", "side": "string" } ], "reason_codes": [ "string" ], "session_id": "string", "side": "string", "status": "string", "step_id": "string", "type": "string", "verification": { "checks": [ { "is_authentic": true, "liveness_score": 0, "portrait_replace_score": 0, "printed_copy_score": 0, "rejection_reasons": [ "string" ], "screen_replay_score": 0, "similarity_score": 0, "status": "string", "type": "string" } ], "status": "string" } } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (default 1)
page_size?integerPage size (1-100, default 50)
action?stringFilter by action
actorId?stringFilter by actor UUID
dateFrom?stringFrom (RFC3339)
dateTo?stringTo (RFC3339)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Paged audit log items
*/*- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/audit' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "page": 0, "page_size": 0, "total_items": 0, "total_pages": 0 }, "success": true, "data": [ { "action": "string", "actor_email": "string", "actor_id": "string", "actor_type": "string", "created_at": "string", "details": { "changes": [ "string" ], "metadata": { "property1": null, "property2": null }, "new_value": { "property1": null, "property2": null }, "old_value": { "property1": null, "property2": null } }, "id": "string", "resource_id": "string", "resource_type": "string", "tenant_id": "string" } ]}GET
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)
Supported documents list
application/json- response
data?unknownsuccess?booleancurl -X GET 'https://example.com/tenant/v1/kyc/documents/supported' \ -H 'X-Timestamp: string'Example Response
{ "data": null, "success": true}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
media_id*stringMedia UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Presigned URL
application/json- response
data?unknownsuccess?booleancurl -X GET 'https://example.com/tenant/v1/kyc/media/string' \ -H 'X-Timestamp: string'Example Response
{ "data": null, "success": true}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
limit?integerMax items (1-50, default 10)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Activity items
*/*- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/metrics/activity' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "id": "string", "message": "string", "metadata": { "property1": null, "property2": null }, "session_id": "string", "timestamp": "string", "type": "session_created" } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Chart data
*/*- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/metrics/chart' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "approved": 0, "date": "string", "pending": 0, "rejected": 0, "total": 0 } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
CSV file
response?stringtext/csvcurl -X GET 'https://example.com/tenant/v1/kyc/metrics/export' \ -H 'X-Timestamp: string'Example Response
"string"GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Funnel steps
*/*- response
data?array<>success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/metrics/funnel' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": [ { "count": 0, "dropoff": 0, "label": "string", "percentage": 0, "step": 0 } ]}GET
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)
Realtime stats
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/metrics/realtime' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "active_sessions": 0, "average_time_last_hour": 0, "completed_last_hour": 0, "error_rate_last_hour": 0, "failed_last_hour": 0, "pending_review": 0, "sessions_last_hour": 0 }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
period?string7d, 30d, 90d, 12m (default 30d)
flow_id?stringFilter by flow UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Stats
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/metrics/stats' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "approval_rate": 0, "approval_rate_change": 0, "avg_processing_time": 0, "avg_processing_time_change": 0, "completed_verifications": 0, "completed_verifications_change": 0, "pending_reviews": 0, "total_sessions": 0, "total_sessions_change": 0 }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (default 1)
page_size?integerPage size (1-100, default 50)
status?stringComma-separated statuses: pending,assigned,in_progress,awaiting_resubmit,approved,rejected,completed
priority?stringComma-separated priorities: low,medium,high,urgent
flow_id?stringFlow UUID
assigned_to?stringReviewer/API key UUID
session_id?stringSession UUID
applicant_id?stringApplicant UUID
q?stringSearch by external ID/name
date_from?stringFrom (RFC3339)
date_to?stringTo (RFC3339)
sla_status?stringSLA status: breached, warning, ok
sort?stringSort order: priority_desc, sla_asc, created_at_asc, created_at_desc
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "page": 0, "page_size": 0, "total_items": 0, "total_pages": 0 }, "success": true, "data": [ { "applicant_first_name": "string", "applicant_full_name": "string", "applicant_full_name_latin": "string", "applicant_full_name_native": "string", "applicant_full_name_original": "string", "applicant_id": "string", "applicant_last_name": "string", "applicant_middle_name": "string", "applicant_nationality": "string", "assigned_at": "string", "assigned_display_name": "string", "assigned_to": "string", "assigned_to_type": "string", "business_company_name": "string", "business_country": "string", "business_external_id": "string", "business_id": "string", "business_registration_number": "string", "business_tax_number": "string", "created_at": "string", "external_user_id": "string", "flow_id": "string", "flow_name": "string", "id": "string", "priority": 0, "reason": "string", "review_reasons": [ {} ], "reviewer_email": "string", "reviewer_first_name": "string", "reviewer_last_name": "string", "session_created_at": "string", "session_environment": "string", "session_id": "string", "sla_breached": true, "sla_deadline": "string", "started_at": "string", "status": "string", "system_decision": "string", "tenant_id": "string", "verification_result": "string", "verification_score": 0 } ]}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "comments": [ { "author_display_name": "string", "author_id": "string", "author_type": "string", "content": "string", "created_at": "string", "id": "string", "task_id": "string" } ], "task": { "applicant_id": "string", "approval_blocked_reason": "string", "assigned_at": "string", "assigned_display_name": "string", "assigned_to": "string", "assigned_to_type": "string", "completed_at": "string", "created_at": "string", "decision": "string", "decision_at": "string", "decision_by": "string", "decision_by_type": "string", "decision_display_name": "string", "external_user_id": "string", "flow_id": "string", "flow_name": "string", "history": [ { "action": "string", "actor_id": "string", "actor_name": "string", "actor_type": "string", "created_at": "string", "details": { "property1": null, "property2": null }, "id": "string" } ], "id": "string", "notes": "string", "priority": 0, "reason": "string", "reason_details": "string", "reject_reason_code": "string", "resubmit_limit_override": 0, "review_reasons": [ {} ], "session_created_at": "string", "session_entity_type": "string", "session_environment": "string", "session_id": "string", "session_status": "string", "status": "string", "system_decision": "string", "tenant_id": "string" } }}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Optional comment and optimistic lock timestamp
application/json- body
comment?stringif_unmodified_since?stringOK
application/json- response
data?unknownsuccess?booleancurl -X POST 'https://example.com/tenant/v1/kyc/review-tasks/string/approve' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": null, "success": true}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?unknownsuccess?booleancurl -X POST 'https://example.com/tenant/v1/kyc/review-tasks/string/assign' \ -H 'X-Timestamp: string'Example Response
{ "data": null, "success": true}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks/string/comments' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "author_display_name": "string", "author_id": "string", "author_type": "string", "content": "string", "created_at": "string", "id": "string", "task_id": "string" } ]}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Comment payload
application/json- body
content?stringContent is the comment text (required, non-empty after trim).
OK
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyc/review-tasks/string/comments' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "author_display_name": "string", "author_id": "string", "author_type": "string", "comment_id": "string", "content": "string", "created_at": "string", "message": "string", "task_id": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
document_id*stringDocument ID or storage key suffix
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?unknownsuccess?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks/string/documents/string/url' \ -H 'X-Timestamp: string'Example Response
{ "data": null, "success": true}PATCH
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Priority payload
application/json- body
priority?stringOK
application/json- response
data?unknownsuccess?booleancurl -X PATCH 'https://example.com/tenant/v1/kyc/review-tasks/string/priority' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": null, "success": true}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Reject payload
application/json- body
comment?stringif_unmodified_since?stringreason_code?stringOK
application/json- response
data?unknownsuccess?booleancurl -X POST 'https://example.com/tenant/v1/kyc/review-tasks/string/reject' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": null, "success": true}POST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Resubmit payload
application/json- body
client_message?stringinternal_notes?stringreason_code?stringrequest_id?stringscope?stringstep_id?stringOK
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyc/review-tasks/string/request-resubmit' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "clientMessage": "string", "createdAt": "string", "deliveredAt": "string", "deliveryChannel": "string", "expiresAt": "string", "fulfilledAt": "string", "id": "string", "internalNotes": "string", "reasonCode": "string", "requestedBy": "string", "requestedByDisplayName": "string", "requestedByType": "string", "scope": "string", "sessionID": "string", "status": "string", "stepID": "string", "taskID": "string", "tenantID": "string", "updatedAt": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
task_id*stringReview task UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks/string/resubmits' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "clientMessage": "string", "createdAt": "string", "deliveredAt": "string", "deliveryChannel": "string", "expiresAt": "string", "fulfilledAt": "string", "id": "string", "internalNotes": "string", "reasonCode": "string", "requestedBy": "string", "requestedByDisplayName": "string", "requestedByType": "string", "scope": "string", "sessionID": "string", "status": "string", "stepID": "string", "taskID": "string", "tenantID": "string", "updatedAt": "string" } ]}GET
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)
OK
application/json- response
data?array<>pagination?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks/reject-reasons' \ -H 'X-Timestamp: string'Example Response
{ "pagination": { "has_more": true, "limit": 0, "next_cursor": "string", "offset": 0, "total": 0 }, "success": true, "data": [ { "category": "string", "code": "string", "label_en": "string", "label_ru": "string" } ]}GET
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)
OK
application/json- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/review-tasks/stats' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "avg_time_minutes": 0, "completed_today": 0, "in_progress": 0, "pending": 0 }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (1-based)
page_size?integerPage size (1-100)
status?stringFilter by status (active, consumed, revoked)
external_user_id?stringFilter by external user ID
external_reference?stringFilter by external reference
flow_id?stringFilter by flow UUID
sort_by?stringSort field (default created_at)
sort_order?stringSort order: asc, desc (default desc)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Verification links
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/verification-links' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "items": [ { "activated_at": "string", "consumed_at": "string", "created_at": "string", "created_by": "string", "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "flow_session_id": "string", "id": "string", "locale": "string", "metadata": { "property1": null, "property2": null }, "prefilled_data": { "property1": null, "property2": null }, "redirect_url": "string", "revoked_at": "string", "revoked_reason": "string", "short_code": "string", "status": "string", "token": "string", "updated_at": "string", "utm_campaign": "string", "utm_medium": "string", "utm_source": "string" } ], "pagination": { "page": 0, "page_size": 0, "total": 0, "total_pages": 0 } }}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/kyc/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" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Verification link details
*/*- response
data?success?booleancurl -X GET 'https://example.com/tenant/v1/kyc/verification-links/string' \ -H 'X-Timestamp: string'Example Response
{ "success": true, "data": { "activated_at": "string", "consumed_at": "string", "created_at": "string", "created_by": "string", "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "flow_session_id": "string", "id": "string", "locale": "string", "metadata": { "property1": null, "property2": null }, "prefilled_data": { "property1": null, "property2": null }, "redirect_url": "string", "revoked_at": "string", "revoked_reason": "string", "short_code": "string", "status": "string", "token": "string", "updated_at": "string", "utm_campaign": "string", "utm_medium": "string", "utm_source": "string" }}GET
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
size?integerQR size in pixels (1-1024, default 256)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
PNG image
response?unknownimage/pngcurl -X GET 'https://example.com/tenant/v1/kyc/verification-links/string/qr' \ -H 'X-Timestamp: string'Example Response
nullPOST
ApiKeyAuthheader
Authorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Optional revoke reason
application/json- body
reason?stringRevoked link info
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyc/verification-links/string/revoke' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "id": "string", "revoked_at": "string", "status": "string" }}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)
Batch create request
application/json- body
defaults?items?array<>Created links
application/json- response
data?success?booleancurl -X POST 'https://example.com/tenant/v1/kyc/verification-links/batch' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "failed": [ { "error": "string", "error_code": "string", "existing_session_id": "string", "index": 0, "link": { "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" } } ], "successful": [ { "error": "string", "error_code": "string", "existing_session_id": "string", "index": 0, "link": { "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" } } ], "summary": { "failed": 0, "successful": 0, "total": 0 } }}