DocumentationAPI Reference
DocumentationAPI Reference

🚧

Deprecated

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

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.

https://withpersona.com/verify?template-id=tmpl_JAZjHuAT738Q63BdgCuEJQre&prefill[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

Parameter

Description

name-first

Given or first name.

name-last

Family or last name.

birthdate

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

address-street-1

Street name of residence address.

address-street-2

Extension of residence address, usually apartment or suite number.

address-city

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

address-subdivision

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

address-postal-code

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

country-code

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

phone-number

Phone number.

email-address

Email address.

identification-number

Identification number.

identification-class

Identification class for number. Examples include "dl" (driver license), "id" (state or national ID), "ssn" (Social Security Number), "pp" (passport), etc.