> For the complete documentation index, see [llms.txt](https://firstoken.gitbook.io/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://firstoken.gitbook.io/api-docs/how-to/create-an-inbound-route.md).

# Create an Inbound Route

An Inbound Route is the entry point through which card data is received by Firstoken for tokenization. Each route defines how data is captured, what token type is generated, and how the response is structured.

#### Before you start

If you plan to assign a Proxy to this route or use a custom domain, create the Proxy first. See [Create a Proxy](/api-docs/how-to/create-a-proxy.md).

#### Steps

1. Log in to the Firstoken Console.
2. Navigate to **Inbound Routes** and click **+ New Inbound Route**.
3. Complete the configuration across the following steps.

***

**Step 1: Basic information**

| Field         | Required | Description                                                                        |
| ------------- | -------- | ---------------------------------------------------------------------------------- |
| Name          | Yes      | Unique identifier for the route.                                                   |
| Description   | No       | Optional context for the route.                                                    |
| Proxy         | No       | Assign a proxy to handle outbound transmission. Must be created beforehand.        |
| Custom Domain | No       | Enable to use a CNAME record for a custom domain. Requires a proxy to be assigned. |
| IP Whitelist  | No       | Restrict access to specific IP addresses or CIDR ranges.                           |

**Step 2: Rules configuration**

| Field              | Required    | Description                                                                                              |
| ------------------ | ----------- | -------------------------------------------------------------------------------------------------------- |
| Token Type         | Yes         | Select **Permanent** or **Temporary**. Permanent tokens can optionally be set as persistent.             |
| Path               | Conditional | Required when using a custom domain. Defines the path where data will be received. Read-only otherwise.  |
| Card Number        | Yes         | Data path for the card number (e.g., `chd.cardnumber`).                                                  |
| Cardholder Name    | Yes         | Data path for the cardholder name (e.g., `chd.holder`).                                                  |
| Expiration Month   | Yes         | Data path for the expiration month (e.g., `chd.expiration.month \| date: MM`).                           |
| Expiration Year    | Yes         | Data path for the expiration year (e.g., `chd.expiration.year \| date: YYYY`).                           |
| CVV                | Conditional | Required for transaction actions (e.g., `chd.csc`).                                                      |
| Tags               | Conditional | Required for tokenization actions (e.g., `tags_IR`).                                                     |
| Overwritten Fields | Yes         | Fields in the response that will be replaced with the token (e.g., `chd` or `cardnumber`).               |
| TTL                | Conditional | Required when action is set to **Transaction**. Defines how long the token remains valid.                |
| Schema             | Conditional | Required when action is set to **Tokenization.** Defines the schema used for tokenization.               |
| Include Metadata   | No          | Select **Yes** to include additional fields in the route response. Provide a name for each custom field. |

**Step 3: Finalization**

Click **Create**. A modal displays the **Route URL** and **Route ID** required for your integration.

> **Note:** The Route URL and Route ID are available again at any time by editing the Inbound Route.

***

#### Verify tokens

| Token type | How to verify                                                              |
| ---------- | -------------------------------------------------------------------------- |
| Permanent  | Firstoken Console > Tokens, or via the TaaS API.                           |
| Temporary  | Transactions API using the transaction ID returned in the inbound request. |