Models

Consumer Object

Attributes

AttributeTypeDescription
phoneNumberstringThe consumer’s phone number. Limited to 32 characters.
givenNamesstring requiredThe consumer’s first name and any middle names. Limited to 128 characters.
surnamestring requiredThe consumer’s last name. Limited to 128 characters.
emailstring requiredThe consumer’s email address. Limited to 128 characters.

Example Consumer Object

Australia

{
  "phoneNumber": "0400 000 000",
  "givenNames": "Joe",
  "surname": "Consumer",
  "email": "test@example.com"
}

New Zealand

{
  "phoneNumber": "0200 000 000",
  "givenNames": "Joe",
  "surname": "Consumer",
  "email": "test@example.com"
}

United States of America

{
  "phoneNumber": "(415) 200-0000",
  "givenNames": "Joe",
  "surname": "Consumer",
  "email": "test@example.com"
}