DocumentationAPI Reference
API ChangelogOpenAPIStatus

Prefilling Fields

Use the fields parameter to dynamically preset inquiry field values. In addition, fields will also prefill form values.

All attributes are optional. You only need to include keys for form fields you want prefilled. Individuals can still edit attributes after they're prefilled.

See Inquiry Fields for more information.

const client = new Persona.Client({
  ...
  fields: {
    nameFirst: "Jane",
    nameLast: "Doe",
    birthdate: "2000-12-31",
    addressStreet1: "132 Second St.",
    addressCity: "San Francisco",
    addressSubdivision: "California",
    addressPostalCode: "93441",
    addressCountryCode: "US",
    phoneNumber: "415-415-4154",
    emailAddress: "[email protected]",
    customAttribute: "hello",
  }
})

❗️

Field values and customers

Using the fields option is intended as a convenience for the end user in a manner similar to browser autofill. Because the client configuration is processed client-side, they can be freely modified by the end user.

If you must guarantee that field values are unmodified by the end user, you must use the external API to set the field values ahead of time.

📘

Encoding passed values

You do not need to make passed values form-safe. The Javascript SDK will automatically encode passed values.

🚧

Phone numbers

Please ensure that phone numbers are properly formatted based on the number's country code. For example, US-based phone numbers should include the prefix +1.