
## Introduction

If you already have certain data about your user, you can share it with Footprint to expedite the onboarding process for your users.
We will pre-fill already available data and skip completed pages for your users. The users can always edit and correct this data
while onboarding through Footprint. To pass user data to Footprint's flow, use the `userData` option:

```typescript
import footprint from '@onefootprint/footprint-js';

const publicKey = 'ob_test_VMooXd04EUlnu3AvMYKjMW';
const userData = {
  'id.email': 'jane.doe@acme.com',
  'id.phone_number': '+12025550179',
  'id.first_name': 'Jane',
  'id.last_name': 'Doe',
  'id.dob': '01/01/2001',
  'id.ssn9': '123456789',
  'id.ssn4': '1234',
  'id.nationality': 'US',
  'id.address_line1': '123 Apple St.',
  'id.address_line2': 'APT 123',
  'id.city': 'Boston',
  'id.state': 'MA',
  'id.country': 'US',
  'id.zip': '02117',
};

const component = footprint.init({ kind: 'verify', publicKey, userData });
component.render();
```

### Available user data

| Variable                  | Description                                                                                                                                 |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `id.email`                | Optional. User email (e.g `jane.doe@acme.com`)                                                                                              |
| `id.phone_number`         | Optional. User phone. Must be in the [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g `+12025550179`)                    |
| `id.first_name`           | Optional. User's first name.                                                                                                                |
| `id.last_name`            | Optional. User's last name.                                                                                                                 |
| `id.dob`                  | Optional. User's date of birth. Must be in MM/DD/YYYY format. (e.g. 01/01/2001)                                                             |
| `id.ssn9`                 | Optional. User's 9-digit SSN number. (e.g. 123456789)                                                                                       |
| `id.ssn4`                 | Optional. The last 4 digits of user's SSN. (e.g. 1234)                                                                                      |
| `id.address_line1`        | Optional. The first line of user's residential address.                                                                                     |
| `id.address_line2`        | Optional. Additional address information, like apartment or suite number. Must be a string.                                                 |
| `id.city`                 | Optional. User's residential city. Must be a string.                                                                                        |
| `id.state`                | Optional. User's residential state. Must be in 2-character [USPS](https://pe.usps.com/text/pub28/28apb.htm) format. (e.g. CA)               |
| `id.country`              | Optional. User's residential country. Must be in [Alpha-2 Code](https://www.iban.com/country-codes) format. (e.g. US)                       |
| `id.zip`                  | Optional. User's residential zip. Must be a string.                                                                                         |
| `id.us_legal_status`      | Optional. User's legal status in the U.S. Must be one of `'citizen'`, `'permanent_resident'`, or `'visa'`.                                  |
| `id.nationality`          | Optional. User's nationality. Must be in [Alpha-2 Code](https://www.iban.com/country-codes) format. (e.g. US)                               |
| `id.citizenships`         | Optional. User's citizenships. Must be an array of [Alpha-2 Codes](https://www.iban.com/country-codes). (e.g. `['BR', 'IT', 'HK']`)         |
| `id.visa_kind`            | Optional. Type of visa the user has. Must be one of `'e1'`, `'e2'`, `'e3'`, `'f1'`, `'g4'`, `'h1b'`, `'l1'`, `'o1'`, `'tn1'`, or `'other'`. |
| `id.visa_expiration_date` | Optional. User's visa expiration date. Must be in MM/DD/YYYY format. (e.g. 01/01/2001)                                                      |
