User data

1 min read

Introduction

Depending on your onboarding configuration, Footprint might request customer's phone number and email. In some circustances, you might have this data already available, so Footprint doesn't need to request this data once more. 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 = { email: 'jane.doe@acme.com', phoneNumber: '+12025550179' };
footprint.open({ publicKey, userData });

Available user data

VariableDescription
emailOptional. User email (e.g jane.doe@acme.com)
phoneNumberOptional. User phone. Must be in the E.164 format (e.g +12025550179)