Create an intake form

QA Environment

https://qa-api.kiolinkapp.com

POST

/v1/kiolink/intake-forms

Intake Forms

Last modified:2026-10-06 22:36:02

Maintainer:José María Esparza Arévalo

Required Permission(s):kiolink-event-create

Creates an intake form for a business device. The signed-in user is recorded as its creator, and responsible.name/email default to the user's.

The business and device must exist, and the device must belong to the business.

Business users can only create forms for their own business.

license_file_url and identification_file_url cannot be sent; upload the files with their endpoints.

Business users only see and change the forms of their own business; KIO users can access every form.

Requires a session token whose role has the kiolink-event-create permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Body Params application/jsonRequired

Example

{
  "form_metadata": {
    "form_name": "KIO Customer Intake Form 4",
    "form_version": "4"
  },
  "equipment_details": {
    "description": "Servidor HPE ProLiant DL380 Gen10",
    "eccn": "5A992.c",
    "huawei_semiconductors_included": false
  },
  "advanced_ics_compliance": {
    "has_advanced_ics": "no",
    "is_restricted_origin": "no"
  },
  "export_license": {
    "is_required": "no",
    "license_status": {
      "has_been_obtained": false,
      "application_submitted": false
    }
  },
  "ownership": {
    "owns_all_equipment": true
  },
  "parties_involved": {
    "applicant": "Digital Ignition"
  },
  "compliance_check": {
    "has_violation_reason": false
  },
  "responsible": {
    "name": "Ana López",
    "email": "ana.lopez@example.com",
    "nationality": "Mexicana"
  },
  "visit_reason": "Instalación de servidor nuevo",
  "_device": "65f1c2a9e4b0a1b2c3d4e5d1",
  "_business": "65f1c2a9e4b0a1b2c3d4e5a1"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/kiolink/intake-forms' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "form_metadata": {
    "form_name": "KIO Customer Intake Form 4",
    "form_version": "4"
  },
  "equipment_details": {
    "description": "Servidor HPE ProLiant DL380 Gen10",
    "eccn": "5A992.c",
    "huawei_semiconductors_included": false
  },
  "advanced_ics_compliance": {
    "has_advanced_ics": "no",
    "is_restricted_origin": "no"
  },
  "export_license": {
    "is_required": "no",
    "license_status": {
      "has_been_obtained": false,
      "application_submitted": false
    }
  },
  "ownership": {
    "owns_all_equipment": true
  },
  "parties_involved": {
    "applicant": "Digital Ignition"
  },
  "compliance_check": {
    "has_violation_reason": false
  },
  "responsible": {
    "name": "Ana López",
    "email": "ana.lopez@example.com",
    "nationality": "Mexicana"
  },
  "visit_reason": "Instalación de servidor nuevo",
  "_device": "65f1c2a9e4b0a1b2c3d4e5d1",
  "_business": "65f1c2a9e4b0a1b2c3d4e5a1"
}'

Responses

🟢201The created form

application/json

The created form.

Bodyapplication/json

Example

{
    "_id": "6a7654b097b768b5ee34c47d",
    "form_metadata": {
        "form_name": "KIO Customer Intake Form 4",
        "form_version": "4"
    },
    "equipment_details": {
        "description": "Servidor HPE ProLiant DL380 Gen10",
        "eccn": "5A992.c",
        "huawei_semiconductors_included": false
    },
    "advanced_ics_compliance": {
        "has_advanced_ics": "no",
        "is_restricted_origin": "no"
    },
    "export_license": {
        "is_required": "no",
        "license_status": {
            "has_been_obtained": false,
            "application_submitted": false
        }
    },
    "ownership": {
        "owns_all_equipment": true
    },
    "parties_involved": {
        "applicant": "Digital Ignition"
    },
    "compliance_check": {
        "has_violation_reason": false
    },
    "responsible": {
        "name": "Ana López",
        "email": "ana.lopez@example.com",
        "nationality": "Mexicana"
    },
    "visit_reason": "Instalación de servidor nuevo",
    "_device": "65f1c2a9e4b0a1b2c3d4e5d1",
    "_business": {
        "_id": "65f1c2a9e4b0a1b2c3d4e5a1",
        "name": "Digital Ignition",
        "normalized_name": "digital ignition",
        "division_name": "Corporativo"
    },
    "_business_user": {
        "_id": "65f1c2a9e4b0a1b2c3d4e5f6",
        "firstname": "Ana",
        "lastname": "López",
        "email": "ana.lopez@example.com",
        "business": "65f1c2a9e4b0a1b2c3d4e5a1"
    },
    "created_at": "2026-10-06T16:00:00.000Z",
    "updated_at": "2026-10-06T16:00:00.000Z",
    "__v": 0
}

🟠400The request does not match the validation rules (Joi), or a

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error

Modified at 2026-10-06 22:36:02

Download an intake form report

Upload a license file