> For the complete documentation index, see [llms.txt](https://aliniex.gitbook.io/alix-pay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/user/submit-user-kyc-information.md).

# Submit User KYC Information

<mark style="color:orange;">`POST`</mark> /api/v2/user/submit-kyc

This API allows you to submit an user kyc information

**Headers**

| Name         | Value                                                                                    |    |               |
| ------------ | ---------------------------------------------------------------------------------------- | -- | ------------- |
| Content-Type | `application/json`                                                                       |    |               |
| lang         | <p>The default will en if this param has been empty. </p><p>Supported languages:<code>en | cn | vi</code></p> |

**Request Body**

```json
{
  "partnerCode": "chinguyen621x",
  "userEmail": "chinontest0000001@gmail.com",
  "firstName": "Chí",
  "lastName": "Nguyen Thanh",
  "dateOfBirth": "1994-06-06",
  "gender": "male",
  "nationality": "VN",
  "type": "ID_CARD",
  "nationalId": "12130163",
  "issueDate": "1994-06-06",
  "expiryDate": "1994-06-06",
  "addressLine1": "Ho Chi Minh",
  "addressLine2": "Go Vap",
  "city": "Ho Chi Minh",
  "state": "Ho Chi Minh",
  "zipCode": "70000",
  "frontIdImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/.........",
  "backIdImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/.........",
  "holdIdImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/.........",
  "phoneNumber": "0968861116",
  "phoneCountryCode": "84",
  "signature": "ZHwy17F5do0pvtvuFZf5DEYJD3JND3J4Ft3oMcICZwYqAwSU3R6aTu2m5mSG2zJDGJlB3W2UZY2jGJJbwerkbFqpAZEeGsKgOw3+phgFEYbwhe6+ZdRjAbWvOZCLF8E+lEdLxEFjBjRXJ9TkFtDHvBfx4p8gFWGSGG5BiLZBIFE="
}
```

**Description**

<table><thead><tr><th width="212.65625">Name</th><th width="82">Type</th><th width="110">Condition</th><th>Value</th></tr></thead><tbody><tr><td><strong>partnerCode</strong></td><td>string</td><td>required</td><td>your partnerCode</td></tr><tr><td><strong>userEmail</strong></td><td>string</td><td>required</td><td>email address of your end-user</td></tr><tr><td>firstName</td><td>string</td><td>required</td><td>first name</td></tr><tr><td>lastName</td><td>string</td><td>required</td><td>last name</td></tr><tr><td>dateOfBirth</td><td>string</td><td>required</td><td>date of birth in the format YYYY-MM-DD</td></tr><tr><td>gender</td><td>string</td><td>required</td><td><ul><li>male</li><li>female</li></ul></td></tr><tr><td>nationalId</td><td>number</td><td>required</td><td><ul><li>If the idType is <strong>ID_CARD ⇒</strong> The id national card number of Vietnamese <strong>(CCCD)</strong></li><li>If  the idType is <strong>PASSPORT ⇒</strong> so the <strong>passport number</strong></li></ul></td></tr><tr><td>nationality</td><td>string</td><td>required</td><td><ul><li>refer here: <a href="https://www.iban.com/country-codes"><strong>https://www.iban.com/country-codes</strong></a></li></ul></td></tr><tr><td>type</td><td>string</td><td>required</td><td><ul><li><strong>ID_CARD</strong></li><li><strong>PASSPORT</strong></li></ul></td></tr><tr><td>issueDate</td><td>string</td><td>required</td><td>The date when the ID was issued, formatted as YYYY-MM-DD</td></tr><tr><td>expiryDate</td><td>string</td><td>required</td><td>The date when the ID expires, formatted as YYYY-MM-DD</td></tr><tr><td><pre><code>addressLine1    
</code></pre></td><td>string</td><td>required</td><td>address</td></tr><tr><td><pre><code>addressLine2
</code></pre></td><td>string</td><td>required</td><td>address</td></tr><tr><td>frontIdImage</td><td>string</td><td>required</td><td>Image on the front of the document as base64 string</td></tr><tr><td>backIdImage</td><td>string</td><td>required</td><td>Image on the back of the document as base64 string</td></tr><tr><td>holdIdImage</td><td>string</td><td>required</td><td>Image on the hand hold of the document as base64 string</td></tr><tr><td>phoneNumber</td><td>string</td><td>optional</td><td>phoneNumber</td></tr><tr><td>phoneCountryCode</td><td>string</td><td>optional</td><td>phoneCountryCode</td></tr><tr><td><strong>signature</strong></td><td>string</td><td>required</td><td><strong>partnerCode</strong>|<strong>userEmail</strong>|<strong>nationality</strong>|<strong>secretKey</strong></td></tr></tbody></table>

**Response**&#x20;

{% tabs %}
{% tab title="200" %}

```json

{
    "success": true,
    "message": "Your request has been successful",
    "data": {
        "nationalId": "1746865978",
        "kycStatus": "PROCESSING",
        "signature":  "ZHwy17F5do0pvtvuFZf5DEYJD3JND3...." //nationalId|kycStatus|secretKey

"
    },
    "errorCode": 0
}

```

{% endtab %}

{% tab title="400" %}

<pre class="language-json"><code class="lang-json">{
    "success": false,
    "message": "[ERROR MESAGE]",
    "data": null,
    "errorCode": 32
}
<strong>
</strong>
</code></pre>

{% endtab %}
{% endtabs %}

**Description of Response Data**&#x20;

<table><thead><tr><th width="264">Name</th><th width="100">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>string</td><td>The id of submitted document</td></tr><tr><td>kycStatus</td><td>string</td><td><p>status of review</p><ul><li>NONE</li><li>PROCESSING</li><li>VERIFIED</li><li>REJECTED</li></ul></td></tr><tr><td>signature</td><td>string</td><td><pre><code>id|kycStatus|secretKey
</code></pre></td></tr></tbody></table>

{% hint style="danger" %}
The KYC review status will update by using [webhook](/alix-pay/api-reference/alix-card-api/cards/notifications-webhook.md) &#x20;
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://aliniex.gitbook.io/alix-pay/api-reference/scan-to-pay-api/user/submit-user-kyc-information.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.