> For the complete documentation index, see [llms.txt](https://innov8tif-solutions.gitbook.io/innov8tif-ekyb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://innov8tif-solutions.gitbook.io/innov8tif-ekyb/cases-api/quickstart.md).

# Create Case

Creates a new eKYB (Electronic Know Your Business) case for business verification. Upon successful case creation, the case status will be `CASE SUBMITTED` and  the verification process will be initiated. 

### Version 1

<mark style="color:$success;">`POST`</mark>  `/api/ekyb/v1/case/create`&#x20;

### Request headers

<table data-header-hidden><thead><tr><th width="158.03125"></th><th width="136.8046875"></th></tr></thead><tbody><tr><td><strong>Header key</strong></td><td><strong>Type</strong></td></tr><tr><td><code>api_id</code></td><td>string</td></tr><tr><td><code>api_key</code></td><td>string</td></tr></tbody></table>

### Request body

<table data-header-hidden><thead><tr><th width="314.54296875"></th><th width="107.77734375">Required</th><th width="89.81640625"></th><th></th></tr></thead><tbody><tr><td><strong>Name</strong></td><td><strong>Required</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td><code>product</code></td><td>true</td><td>string</td><td>Product name/type</td></tr><tr><td><code>UBOCheck</code></td><td>false</td><td>string</td><td><p>Enable UBO verification. Valid values: </p><ul><li><code>"checked"</code></li><li><code>""</code> (empty string)</li></ul></td></tr><tr><td><code>customerDetails</code></td><td>true</td><td>object</td><td>Customer details</td></tr><tr><td><code>customerDetails.companyNo</code></td><td>true</td><td>string</td><td>Company registration number</td></tr><tr><td><code>customerDetails.companyName</code></td><td>true</td><td>string</td><td>Company name</td></tr><tr><td><code>customerDetails.entityType</code></td><td>true</td><td>string</td><td><p>Entity type</p><p>Valid values: </p><ul><li><code>"B"</code> - Business (Sole Propriertorship / Partnership)</li><li><code>"C"</code> - Company(Sdn. Bhd. / Bhd.)</li></ul></td></tr><tr><td><code>customerDetails.cpRefCode</code></td><td>false</td><td>string</td><td>Customer/Partner reference code</td></tr><tr><td><code>customerDetails.cpRefCode2</code></td><td>false</td><td>string</td><td>Secondary reference code</td></tr><tr><td><code>contactPersonDetails</code></td><td>true</td><td>object</td><td>Contact person details</td></tr><tr><td><code>contactPersonDetails.contactName</code></td><td>true</td><td>string</td><td>Full name of contact person</td></tr><tr><td><code>contactPersonDetails.contactEmail</code></td><td>true</td><td>string</td><td>Valid email address</td></tr><tr><td><code>contactPersonDetails.contactPhoneNo</code></td><td>true</td><td>string</td><td><p>Phone number </p><p><mark style="color:$danger;">&#x3C;Valid format></mark></p></td></tr><tr><td><code>directorDetails</code></td><td>true</td><td>array</td><td>At least 1 director should be provided</td></tr><tr><td><code>directorDetails[].directorName</code></td><td>true</td><td>string</td><td>Director's full name as per IC.</td></tr><tr><td><code>directorDetails[].directorIcNo</code></td><td>true</td><td>string</td><td>Director's IC/Passport number.</td></tr><tr><td><code>directorDetails[].dateOfBirth</code></td><td>false</td><td>string</td><td><p>Date of birth. </p><p>Format: <code>"yyyy-MM-dd"</code></p></td></tr><tr><td><code>directorDetails[].gender</code></td><td>false</td><td>string</td><td><p>Gender. </p><p>Valid values:</p><ul><li><code>"Male"</code></li><li><code>"Female"</code></li></ul></td></tr><tr><td><code>directorDetails[].directorEmail</code></td><td>true</td><td>string</td><td>Director's email.</td></tr><tr><td><code>directorDetails[].directorPhoneNo</code></td><td>true</td><td>string</td><td>Director's phone number</td></tr><tr><td><code>directorDetails[].AMLCheck</code></td><td>false</td><td>string</td><td><p>Enable AML check. </p><p>Valid Values: </p><ul><li><code>"checked"</code></li><li><code>""</code> (empty string)</li></ul></td></tr><tr><td><code>directorDetails[].directorEKYCCheck</code></td><td>false</td><td>string</td><td><p>Enable eKYC verification.</p><p>Valid Values: </p><ul><li><code>"checked"</code></li><li><code>""</code>(empty string)</li></ul></td></tr></tbody></table>

<details>

<summary><strong>Request Body Sample</strong></summary>

```
{
  "product": "ekyb_pro",
  "UBOCheck": "checked",
  "customerDetails": {
    "companyNo": "1234567-X",
    "companyName": "Tech Solutions Sdn Bhd",
    "entityType": "C",
    "cpRefCode": "REF001",
    "cpRefCode2": "SEC002"
  },
  "contactPersonDetails": {
    "contactName": "John Doe",
    "contactEmail": "john@example.com",
    "contactPhoneNo": "0123456789"
  },
  "directorDetails": [
    {
      "directorName": "Jane Doe",
      "directorIcNo": "900101-14-1234",
      "dateOfBirth": "1990-01-01",
      "gender": "Female",
      "directorEmail": "jane@example.com",
      "directorPhoneNo": "0129876543",
      "AMLCheck": "checked",
      "directorEKYCCheck": "checked"
    },
    {
      "directorName": "Tom Doe",
      "directorIcNo": "890101-14-1234",
      "dateOfBirth": "1989-01-01",
      "gender": "Male",
      "directorEmail": "tom@example.com",
      "directorPhoneNo": "0129876544",
      "AMLCheck": "",
      "directorEKYCCheck": "checked"
    }
  ]
}
```

</details>

### Response body

<table data-header-hidden><thead><tr><th width="158.03125"></th><th width="136.8046875"></th><th></th></tr></thead><tbody><tr><td><strong>Name</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td><code>recordId</code></td><td>string</td><td>The unique record ID of the created case</td></tr><tr><td><code>caseId</code></td><td>string</td><td>The readable case ID</td></tr><tr><td><code>message</code></td><td>string</td><td>Success or error message</td></tr></tbody></table>

### &#x20;Response Body Sample

<details>

<summary><strong>Successful response</strong></summary>

```
{
    "recordId": "rec_12345",
    "caseId": "Case-160227-qn28dz",
    "message": "Case created successfully"
}
```

</details>

<details>

<summary><strong>Error response</strong></summary>

```
{
  "recordId": "",
  "errors": {
    "product": "Product is required",
    "customerDetails.companyNo": "Company number is required",
    "customerDetails.companyName": "Company name is required",
    "customerDetails.entityType": "Invalid entity type. Must be 'B' (Business) or 'C' (Company)",
    "contactPersonDetails.contactName": "Contact name is required",
    "contactPersonDetails.contactEmail": "Invalid email format",
    "contactPersonDetails.contactPhoneNo": "Contact phone number is required",
    "directorDetails": "At least one director is required"
  }
}
```

</details>