Skip to main content

post-1-click-request-body-table-shared

PropertyRequired?TypeFormatDefaultDescriptionExample phonerequiredstringE.164noneUser's phone number (in E.164 format)"+12125550010" emailoptionalstringemailnoneUser's email address"richard@piedpiper.net" birthDateoptionalstringYYYY-MM-DDnoneUser's birth date (in Sandbox, this must be "1989-08-01" to pass validation)"1989-08-01" ssn4optionalstring4 digits (0-9)noneLast 4 digits of user's Social Security Number (in Sandbox, this must be "6789" to pass validation)"6789" fullNameoptionalObjectObject with keys for one or more child credentials listed belownoneFull name
{
    "firstName": "Richard",
    "lastName": "Hendricks"
}
↳ fullName.firstNameoptionalstringcAse inSensiTivenoneFirst name"Richard" ↳ fullName.middleNameoptionalstringcAse inSensiTivenoneMiddle name"Harrison" ↳ fullName.lastNameoptionalstringcAse inSensiTivenoneLast name"Hendricks" addressoptionalObjectObject with keys for one or more child credentials listed belownoneAddress
{
    "line1": "5320 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "zipCode": "94303",
    "country": "US"
}
↳ address.line1optionalstringcAse inSensiTiveLine 1 of address"5320 Newell Rd" ↳ address.line2optionalstringcAse inSensiTiveLine 2 of address"" ↳ address.cityoptionalstringcAse inSensiTiveCity of address"Palo Alto" ↳ address.stateoptionalstring
  • 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.zipCodeoptionalstring
  • ZIP Code (5 digits, 0-9)
  • ZIP+4 (5 digits, 0-9 + - + 4 digits, 0-9)
noneZIP Code of address
  • "94303"
  • "94303-2846"
↳ address.countryoptionalstring
  • 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")
Country of address
  • "US"
  • "United States of America"
credentialRequestsoptionalCredentialRequest[]See CredentialRequestDefined by the default credential requests brand setting in your DashboardList of CredentialRequest objects (which encode which credentials you're asking for)See CredentialRequest example