MngAddKycStepTemplate

Creates a reusable KYC step template for a brand.

REST Endpoint

POST /manager/kyc/templates

Request

{
  "command": "MngAddKycStepTemplate",
  "data": {
    "brand": "default",
    "code": "proof_id",
    "level": 1,
    "name": "Proof of identity",
    "description": "Government issued identity document",
    "step_type": 0,
    "required": 1,
    "sort_index": 10,
    "requirements": {
      "documents": ["passport", "national_id"]
    },
    "form_schema": {
      "sections": []
    }
  }
}

Parameters

Name	Type	Required	Description
brand	string	Yes	Brand namespace
code	string	Yes	Stable template code
level	int	Yes	KYC level this step belongs to
name	string	No	Display name
description	string	No	Description
step_type	int	No	0 document, 1 questionnaire, 2 mixed, 3 provider, 4 manual
required	int	No	1 required, 0 optional
sort_index	int	No	UI ordering
requirements	object	No	Requirements metadata
form_schema	object	No	Questionnaire schema

Form Schema Validation

form_schema must be a JSON object. If it contains sections, sections must be an array. Each section can contain a fields array.

Every field must have a unique non-empty name. Supported field types are text, textarea, date, country, file_reference, number, boolean, select, and multi_select. If required is provided, it must be boolean. For select and multi_select, options must be an array when provided.

Response

{
  "template": {
    "id": 1,
    "brand": "default",
    "level": 1,
    "code": "proof_id",
    "name": "Proof of identity",
    "step_type": 0,
    "required": 1,
    "status": 0
  }
}