post-client-1-click-request-body-table

PropertyRequired?TypeFormatDefaultDescriptionExample verificationUuid

Optional

stringVersion 4 UUIDUnique identifier for a 1ClickVerificationEntity that can be passed to the SDK to skip the phone entry and verification steps"487246b0-e68c-451d-be8e-45cea0b1c7a2" phone

Optional

stringE.164noneUser's phone number (in E.164 format)"+12125550010" email

Optional

stringemailnoneUser's email address"richard@piedpiper.net" birthDate

Optional

stringYYYY-MM-DDnoneUser's birth date (in Sandbox, this must be "1989-08-01" to pass validation)"1989-08-01" ssn4

Optional

string4 digits (0-9)noneLast 4 digits of user's Social Security Number (in Sandbox, this must be "6789" to pass validation)"6789" fullName

Optional

ObjectObject with keys for one or more child credentials listed belownoneFull name

{
    "firstName": "Richard"
}

↳ fullName.firstName

Optional

but

Required

with fullNamestringcAse inSensiTivenoneFirst name"Richard" ↳ fullName.middleName

Optional

stringcAse inSensiTivenoneMiddle name"Harrison" ↳ fullName.lastName

Optional

stringcAse inSensiTivenoneLast name"Hendricks" address

Optional

ObjectObject with keys for one or more child credentials listed belownoneAddress

{
    "line1": "5320 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "zipCode": "94303",
    "country": "US"
}

↳ address.line1

Optional

stringcAse inSensiTivenoneLine 1 of address"5320 Newell Rd" ↳ address.line2

Optional

stringcAse inSensiTivenoneLine 2 of address"" ↳ address.city

Optional

stringcAse inSensiTivenoneCity of address"Palo Alto" ↳ address.state

Optional

string

• 2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory)
• Full state/territory name (ISO 3166-2 subdivision name)

noneState of address

• "CA"
• "California"

↳ address.zipCode

Optional

string

• ZIP Code (5 digits, 0-9)
• ZIP+4 (5 digits, 0-9 + - + 4 digits, 0-9)

noneZIP Code of address

• "94303"
• "94303-2846"

↳ address.country

Optional

string

• 2 letter abbreviation (ISO 3166-1 alpha-2 code, currently always "US")
• Full country name (ISO 3166-1 English short name, currently always "United States of America")

noneCountry of address

• "US"
• "United States of America"