KYCIS SDK Docs
Sdk

Event Contract

Canonical event semantics between Android SDK and backend

Primary endpoint

  • POST /v1/events

Used by SDK for ingestion events such as:

  • identity
  • component_input
  • validation_failed
  • screen_schema
  • screen_schema_lazy
  • voice_conversation_turn (voice agent side)

Important fields

  • event: ingestion event type
  • screen / screen_id: current UI step identifier
  • component_id / component_type: input component context
  • hint + masked: input hint and masking state
  • traceparent, trace_id, request_id: correlation

Trigger + session APIs (non-event)

  • POST /v1/assistant/trigger/evaluate
  • POST /v1/assistant/session/start
  • POST /v1/assistant/session/stop
  • GET /v1/assistant/context/{session_id}

Source of truth docs

For the full canonical schema and examples, refer to:

  • EVENT_CONTRACTS.md
  • API_CONTRACTS.md

On this page