# Generate KYC Link

This API allows clients to generate a unique KYC link for their users to verify their identity. The generated link can be sent to the user via the postman channel. Once the user follows the link, they will be prompted to provide the required information and documents for KYC verification.

### Base URL

```
sdk.faceki.com
```

### Generate KYC Link End Point API

```
https://sdk.faceki.com/kycverify/api/kycverify/kyc-verify-link
```

{% hint style="info" %}
Method: POST

Authorization: Bearer Token

Content-Type: application/json
{% endhint %}

<mark style="color:green;">`POST`</mark> `https://sdk.faceki.com/kycverify/api/kycverify/kyc-verify-link`

#### Headers

| Name                                            | Type   | Description      |
| ----------------------------------------------- | ------ | ---------------- |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer \[token]  |
| Content-Type<mark style="color:red;">\*</mark>  | String | application/json |

#### Request Body

| Name               | Type    | Description                                                                      |
| ------------------ | ------- | -------------------------------------------------------------------------------- |
| expiryTime         | String  | expiryTime in minutes                                                            |
| applicationId      | String  | Unique Identifier for record                                                     |
| redirect\_url      | String  | Redirect URL After KYC                                                           |
| document\_optional | Boolean | Pass True if you want customer to choose 1 document out of N defined in workflow |

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

```
{
    "responseCode": 0,
    "data": "bdb21481-7873-45d5-0000-18df4a7bf778",
    "url": "https://apps.faceki.com/kycverify/bdb21481-7873-45d5-0000-18df4a7bf778"
}
```

{% endtab %}

{% tab title="401: Unauthorized " %}

```javascript
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

<figure><img src="/files/7YQq2RNfjUQo4jbb7Y8C" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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://kycdocv2.faceki.com/api-integration/verification-apis/generate-kyc-link.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.