DocumentationAPI Reference
API ChangelogOpenAPI SpecStatus

Hosted Integration Prefill



prefill has been deprecated and will be replaced by the fields attribute.

View our migration guide for more information.

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

The prefill value should be an object encoded as a string using a library like qs.

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.[name-first]=Jane&prefill[name-last]=Doe&prefill[birthdate]=1957-05-29&prefill[address-street-1]=132 Second St.&prefill[address-city]=San Francisco&prefill[address-subdivision]=California&prefill[address-postal-code]=93441&prefill[country-code]=US&prefill[phone-number]=415-123-1234&prefill[email-address][email protected]

Prefill parameters

name-firstGiven or first name.
name-lastFamily or last name.
birthdateBirthdate, must be in the format "YYYY-MM-DD".
address-street-1Street name of residence address.
address-street-2Extension of residence address, usually apartment or suite number.
address-cityCity of residence address. Not all international addresses use this attribute.
address-subdivisionState or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.
address-postal-codeZIP or postal code of residence address. Not all international addresses use this attribute.
country-codeISO 3166-1 alpha 2 country code of the government ID to be verified. This is generally their country of residence as well.
phone-numberPhone number.
email-addressEmail address.
identification-numberIdentification number.
identification-classIdentification class for number. Examples include "dl" (driver license), "id" (state or national ID), "ssn" (Social Security Number), "pp" (passport), etc.