> For the complete documentation index, see [llms.txt](https://legacy-docs.usesmileid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy-docs.usesmileid.com/integration-options/no-code/smile-links.md).

# Smile Links

## Overview

Smile Links is a no-code service that lets you build a custom user verification web application to share with your end-users through a secure link.

With a few clicks on the Smile ID Portal, you can create a link to verify any ID type Smile ID covers using a document photo or ID number. Tailor the link to your brand by adding your company information and logo, providing a seamless experience for your users.

You can view the results of the verifications completed through the link on the Smile Portal Job List page for a complete no-code verification process.

## Supported Products (Verification Methods)

Smile Links are compatible with our Enhanced KYC, Biometric KYC and Document Verification products. A single Smile Link can support multiple verification methods (products). You can enable numerous ID types from different countries on a single link.

**Note**: Only one verification method (Product) is supported per ID type.

**Example:**\
You **can** enable Document Verification for Nigerian Passports AND Biometric KYC for South African national IDs within the same link.

You **cannot** enable Document Verification for South African National ID AND Biometric KYC for South African National ID within the same link. If you want to do two verification methods for the same ID type, create two separate Smile Links.\\

## How to create a link

Login into the Smile ID Portal and navigate to the **Smile Links** section from the side navigation bar. To begin setting up your first Smile Link, click the “**Create a new link”** button.

### 1. Add ID

The first step is to select the ID types you want to verify with the link. Remember, You can enable multiple ID types from different countries on a single link. To add an ID:

1. Click the “**Add an ID”** button\*\*.\*\*
2. Search or select the issuing country of the ID.
3. Select the type of ID you want to verify (National ID, Passport, Voter ID, etc.).
4. Choose your preferred verification method. In other words, if you want to verify using an ID document or government database.

You can follow these steps as often as needed to add multiple ID types. You can also edit the verification methods for each ID after adding or removing an ID from the list altogether.

### 2. Customise Link

After adding IDs, click continue to customise your Smile Link’s verification interface. This is the webpage (entry point) your customer will see when performing their identity check.

If you have not previously entered any customisation information, you will be required to add details about your company and your data privacy policy. Once you add your details the first time, they will be saved as the default for future links. You can change these details at any time.

**There are several items on the user verification page you can customise:**

1. **Company Logo:** The company or product logo you want the users to see on the verification interface.
2. **Data Privacy Policy Link:** Adding your privacy policy to your user interface guarantees compliance with data and privacy regulations. The URL should link to your privacy or data policy webpage.
3. **Optional Callback URL:** If you want to receive the link results via code, you can add a `callback URL` where the JSON results will be posted. By default, we will post the results to the default callback URL you have set up in your Smile Dev Settings.\
   \
   Results are available on the jobs list page of the portal regardless of setting a callback.

Once you are happy with your web app interface customisations, save them by clicking “Save Configurations”. This will automatically redirect you to the "Link Settings" tab.\
\
In the "Link Settings" tab, you will specify how your link will function.

1. First, give your link a name. This will be the name of your link in the Smile ID portal, allowing you to track and manage your link.
2. Select your link type. There are [two types](#types-of-links) of Smile Links: [Single User Links](#1.-single-user-link) and [Multiple User Links](#2.-multiple-user-link).
3. Set your link [expiry](#expiration). The expiration for links is 90 days. If you wish to extend or reduce the time the Link is live, toggle off the 90-day expiry and type in the number of days you would like the link to stay active.

### **3. Publish Links**

Once your link is published, share it directly with your customers or embed it in your application.\
\
To share the URL copy is from the screen or share directly to WhatsApp, Email or Telegram. The URL will always be available on the "Manage Links" page if you need it again later.

## Types of Links

There are two types of Smile Links:

### **1. Single User Link**

A single-user link is designed for one-time use by a single user. Create a link for new users by randomly generating a unique User ID or typing in your own. For pre-existing users (previously verified on Smile), you can create a link for them using their existing User ID.

#### Example Use Cases for Single-User Links <a href="#ykqdmnjgelul" id="ykqdmnjgelul"></a>

**Use-Case 1:** Onboarding a specific customer for the first time. You select specific IDs from a country and share a **single user link** with them so they carry out their verification process. For this, you can auto-generate a user ID.

**Use-Case 2:** You used Smile ID to onboard a customer with their BVN. To increase their account tier, you must verify their virtual NIN (VNIN). You can share a single user link for the VNIN verification and add their existing user ID. The VNIN verification would be tied to that existing user.

### **2. Multiple User Link**

This link is generated once but can be used by multiple users to perform their verifications.

**Example Use Cases for Multiple User Links**\
\
**Use-case 1**: You want to verify customers with different IDs in one country; you can create a **multiple-user link** for this purpose.

**Use-case 2**: You want to run a marketing campaign for onboarding customers through WhatsApp; you can create a **multiple-user link** for all verifiable IDs in that country and share it with users directly on WhatsApp.

## Expiration

Links expire after 90 days by default. This means that 90 days after the link is activated, users can no longer use it for verification.

You can change the duration the link is active by toggling the 90-day expiry off and typing in the number of days you would like your link to stay live.

## Managing your Smile Links

You can see all your generated Smile Links on the Manage Smile Links page. There are separate tabs for multi-user links and single-user links.\
\
You can search for your links with the link name you set for it or the user ID (for single-user links). ***Expired links will still show up on the manage link page.***

You can also view other important information about your links here, such as how many users have used each for verification and the success rate of the verifications.

There is the option to pause, stop, and edit your links on this page.

## User Experience with Smile Links

After you publish a link, share it with your users to perform their KYC verification. Your user will be redirected to a webpage with your custom verification information.

Depending on whether you are verifying ID documents or against government databases, the web application will automatically adapt the user flow for collecting ID document images, user’s selfie and/or ID information.


---

# 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, and the optional `goal` query parameter:

```
GET https://legacy-docs.usesmileid.com/integration-options/no-code/smile-links.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.