DocumentationAPI Reference
DocumentationAPI Reference

🚧

Deprecated

prefill has been deprecated and will be replaced by the fields attribute. fields allows specifying custom inquiry fields, rather than being limited to the hardcoded set exposed by prefill.

Users using Templates should still use prefill when working with Templates, but should use fields when working with Inquiry Templates.

View our migration guide for more information.

Use the prefill component prop to prefill input fields in form entry verifications such as Basic and SSN. See Verification Types for all form entry verifications.

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.

<Persona.Inquiry
    prefill={{
      nameFirst: "Jane",
      nameLast: "Doe",
      birthdate: "2000-12-31",
      addressStreet1: "132 Second St.",
      addressCity: "San Francisco",
      addressSubdivision: "California",
      addressPostalCode: "93441",
      countryCode: "US",
      phoneNumber: "415-415-4154",
      emailAddress: "[email protected]"
    }}
    ...
  />

Prefill parameters

Parameter

Description

nameFirst

Given or first name.

nameLast

Family or last name.

birthdate

Birthdate, must be in the format "YYYY-MM-DD".

addressStreet1

Street name of residence address.

addressStreet2

Extension of residence address, usually apartment or suite number.

addressCity

City of residence address. Not all international addresses use this attribute.

addressSubdivision

State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.

addressPostalCode

ZIP or postal code of residence address. Not all international addresses use this attribute.

countryCode

ISO 3166-1 alpha 2 country code of the government ID to be verified. This is generally their country of residence as well.

phoneNumber

Phone number. Can format as just digits or using hyphens "-" as a separator.

emailAddress

Email address.