# 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="https://3621714085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQdiwjdAaMBpDtolO59Ll%2Fuploads%2FGAwcVBg4wKdaxfI4jK1s%2FWhatsApp%20Image%202023-05-30%20at%204.39.17%20PM.jpeg?alt=media&#x26;token=f68edb2c-c482-4dd2-b65d-6349b3c77e10" alt=""><figcaption></figcaption></figure>