Buyer

Buyer represents a buyer

{
  "activeAuthorizedThirdParties": [
    {
      "buyerID": "ae487b2e-c4fc-48a6-8cd5-88507cba82bb",
      "consentToCall": false,
      "consentToEmail": false,
      "consentToText": false,
      "createdAt": "2020-12-31T15:10:55Z",
      "email": "john.doe@gmail.com",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": false,
      "name": {
        "givenName": "John",
        "familyName": "Doe",
        "additionalName": "string"
      },
      "phone": "+14539842345",
      "powerOfAttorney": false,
      "attorneyRepresentation": false,
      "type": "string",
      "phoneType": "string",
      "updatedAt": "2020-12-31T15:10:55Z"
    }
  ],
  "contacts": {
    "property1": {
      "address": {
        "address1": "156 5th Avenue",
        "address2": "string",
        "locality": "New York",
        "postalCode": "10019",
        "region": "US-NY",
        "country": "US",
        "addressType": "Firm"
      },
      "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
      "contactType": "PRIMARY",
      "createdAt": "2020-12-31T15:10:55Z",
      "email": "john.doe@gmail.com",
      "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
      "name": {
        "givenName": "John",
        "familyName": "Doe",
        "additionalName": "string"
      },
      "phone": "+14539842345",
      "updatedAt": "2020-12-31T15:10:55Z"
    },
    "property2": {
      "address": {
        "address1": "156 5th Avenue",
        "address2": "string",
        "locality": "New York",
        "postalCode": "10019",
        "region": "US-NY",
        "country": "US",
        "addressType": "Firm"
      },
      "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
      "contactType": "PRIMARY",
      "createdAt": "2020-12-31T15:10:55Z",
      "email": "john.doe@gmail.com",
      "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
      "name": {
        "givenName": "John",
        "familyName": "Doe",
        "additionalName": "string"
      },
      "phone": "+14539842345",
      "updatedAt": "2020-12-31T15:10:55Z"
    }
  },
  "createdAt": "2020-12-31T15:10:55Z",
  "employment": {
    "annualIncome": 10000,
    "companyAddress": "string",
    "companyName": "string",
    "currency": "USD",
    "description": "string",
    "occupation": "string",
    "occupationDescription": "string",
    "type": "string"
  },
  "id": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
  "identity": {
    "birthDate": "2020-12-31",
    "email": "john.doe@gmail.com",
    "emailDuplicate": true,
    "emailVerified": true,
    "iin": "string",
    "hasIIN": true,
    "iinShort": "string",
    "name": {
      "givenName": "John",
      "familyName": "Doe",
      "additionalName": "string"
    },
    "phone": "+14539842345",
    "phoneDuplicate": true,
    "phoneVerified": true
  },
  "languagePreference": "en or en-US",
  "primaryContactID": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
  "status": "ACTIVE",
  "subStatus": "ACTIVE",
  "tenantID": "d8a265ce-5d9c-4d0b-9edd-401450f78e09",
  "activeMilitary": true,
  "bankruptcy": {
    "id": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
    "buyerId": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
    "filingStatus": "PETITIONED",
    "notice": "CHAPTER 7",
    "filingDate": "2020-12-31",
    "transitionDate": "2020-12-31",
    "createdAt": "2020-12-31T15:10:55Z",
    "updatedAt": "2020-12-31T15:10:55Z"
  },
  "doNotSellOrShare": true,
  "primaryContact": {
    "address": {
      "address1": "156 5th Avenue",
      "address2": "string",
      "locality": "New York",
      "postalCode": "10019",
      "region": "US-NY",
      "country": "US",
      "addressType": "Firm"
    },
    "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
    "contactType": "PRIMARY",
    "createdAt": "2020-12-31T15:10:55Z",
    "email": "john.doe@gmail.com",
    "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
    "name": {
      "givenName": "John",
      "familyName": "Doe",
      "additionalName": "string"
    },
    "phone": "+14539842345",
    "updatedAt": "2020-12-31T15:10:55Z"
  },
  "doNotSellOrShareUpdatedAt": "2020-12-31T15:10:55Z",
  "updatedAt": "2020-12-31T15:10:55Z"
}

Properties

Name	Type	Required	Restrictions	Description
activeAuthorizedThirdParties	[object]	false	none	Subresource of buyer and acted on with its own set of endpoints
➥ buyerID	string(uuid)	false	read-only	The ID of the buyer on whose behalf this authorized third party is allowed to act.
➥ consentToCall	boolean	false	none	Whether this authorized third party has consented to receive calls.
➥ consentToEmail	boolean	false	none	Whether this authorized third party has consented to receive emails.
➥ consentToText	boolean	false	none	Whether this authorized third party has consented to receive text messages.
➥ createdAt	string(date-time)	false	none	Time this entity was created.
➥ email	string(email)	false	none	Email address.
➥ id	string(uuid)	false	read-only	Unique ID associated with this authorized third party.
➥ isActive	boolean	false	none	Indicates whether this authorized third party is active.
➥ name	object	true	none	Full name.
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	true	none	Phone number.
➥ powerOfAttorney	boolean	false	none	Indicates whether this authorized third party has power of attorney for the associated buyer. Power of attorney legally grants a third party the ability to represent the buyer in private affairs.
➥ attorneyRepresentation	boolean	false	none	Indicates whether this authorized third party is an attorney acting on behalf of the buyer.
➥ type	string	false	none	AuthorizedThirdPartyType represents a authorized third party type as enum Possible values: `AUTHORIZED_THIRD_PARTY`, `POWER_OF_ATTORNEY`, `ATTORNEY_REPRESENTATION`, `GUARDIANSHIP`
➥ phoneType	string	false	none	PhoneType represents a phone type as enum Possible values: `MOBILE`, `WORK`, `HOME`, `OTHER`
➥ updatedAt	string(date-time)	false	none	Time this entity was last updated.
contacts	object	true	none	BuyerContactMap represents a mapping of buyer contact IDs to contacts
➥ additionalProperties	object	false	none	BuyerContact represents a set of contact information.
➥➥ address	object	false	none	Represents a fully defined address for an entity
➥➥➥ address1	string	true	none	First address line
➥➥➥ address2	string	false	none	Second address line
➥➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥➥➥ addressType	string	false	read-only	Represents the type of address.
➥➥ buyerID	string(uuid)	false	read-only	ID of the buyer associated with this contact.
➥➥ contactType	string	false	none	Optional. Represents the type of contact.
➥➥ createdAt	string(date-time)	false	none	Time this entity was created.
➥➥ email	string(email)	true	none	Email address.
➥➥ id	string(uuid)	false	read-only	Unique ID associated with this contact.
➥➥ name	object	true	none	Full name.
➥➥➥ givenName	string	true	none	Given name
➥➥➥ familyName	string	true	none	Family name
➥➥➥ additionalName	string	false	none	Additional name, if any
➥➥ phone	string	true	none	Phone number.
➥➥ updatedAt	string(date-time)	false	none	Time this entity was last updated.
createdAt	string(date-time)	true	none	Time this entity was created.
employment	object	false	none	Optional. Employment represents the buyer's employment.
➥ annualIncome	integer(int64)	false	none	Optional. The buyer's annual income in cents.
➥ companyAddress	string	false	none	Required if employment type is `EMPLOYED` or `SELF_EMPLOYED`
➥ companyName	string	false	none	Required if employment type is `EMPLOYED` or `SELF_EMPLOYED`
➥ currency	string	false	none	Required if annual income exists
➥ description	string	false	none	Optional. Employment description.
➥ occupation	string	false	none	Required if employment type is `EMPLOYED` or `SELF_EMPLOYED`
➥ occupationDescription	string	false	none	Required if occupation is "Other"
➥ type	string	true	none	EmploymentType represents a buyer employment type as enum Possible values: `EMPLOYED`, `SELF_EMPLOYED`, `UNEMPLOYED`, `STUDENT`, `RETIRED`
id	string(uuid)	true	read-only	Unique ID associated with this buyer.
identity	object	true	none	Identity represents the identity of a buyer
➥ birthDate	string(date)	false	none	Optional - if provided, date must be within valid range Ex. 1900-01-01
➥ email	string(email)	true	none	Email address.
➥ emailDuplicate	boolean	false	read-only	Indicates whether this email is verified on another buyer.
➥ emailVerified	boolean	false	none	Indicates whether this email has been verified as belonging to this buyer. Write access to this field is limited based on authorization.
➥ iin	string	false	none	Optional. The Individual Identification Number of this buyer. Read access limited based on authorization. Write access limited based on authorization unless no value currently exists.
➥ hasIIN	boolean	false	read-only	Indicates whether a full IIN has been provided for this buyer.
➥ iinShort	string	false	none	Optional. The short form of the buyer's Individual Identification Number. Will always match full IIN if full IIN exists. Write access limited based on authorization unless no value currently exists.
➥ name	object	true	none	Full name.
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	true	none	Phone number.
➥ phoneDuplicate	boolean	false	read-only	Indicates whether this phone number is verified on another buyer.
➥ phoneVerified	boolean	false	none	Indicates whether this phone number is has been verified as belonging to this buyer. Write access to this field is limited based on authorization.
languagePreference	string	true	none	Buyer's preferred language.
primaryContactID	string(uuid)	true	read-only	Read-only. The ID of the primary contact information associated with this buyer; this is set on buyer creation.
status	string	false	none	Status represents buyer status as string. Options available will depend on tenant level configurations
subStatus	string	false	none	SubStatus represents buyer sub status as constant string. Options available will depend on status value and tenant level configurations
tenantID	string(uuid)	true	none	ID of the tenant associated with this buyer.
activeMilitary	boolean	false	none	Indicates if the buyer is a member of the armed forces.
bankruptcy	object	false	none	Bankruptcy represents a buyer's bankruptcy information
➥ id	string(uuid)	false	read-only	Unique ID associated with this bankruptcy.
➥ buyerId	string(uuid)	false	read-only	Unique ID associated with the buyer.
➥ filingStatus	string	true	none	The buyer's bankruptcy filing status.
➥ notice	string	true	none	The bankruptcy notice chapter received by the buyer.
➥ filingDate	string(date)	true	none	The date the buyer filed for bankruptcy.
➥ transitionDate	string(date)	false	none	The latest date the buyer transitioned bankruptcy chapters.
➥ createdAt	string(date-time)	false	none	Time this entity was created.
➥ updatedAt	string(date-time)	false	none	Time this entity was updated.
doNotSellOrShare	boolean	false	none	Indicates if the buyer has preference for their data not to be shared
primaryContact	object	false	none	BuyerContact represents a set of contact information.
➥ address	object	false	none	Represents a fully defined address for an entity
➥➥ address1	string	true	none	First address line
➥➥ address2	string	false	none	Second address line
➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥➥ addressType	string	false	read-only	Represents the type of address.
➥ buyerID	string(uuid)	false	read-only	ID of the buyer associated with this contact.
➥ contactType	string	false	none	Optional. Represents the type of contact.
➥ createdAt	string(date-time)	false	none	Time this entity was created.
➥ email	string(email)	true	none	Email address.
➥ id	string(uuid)	false	read-only	Unique ID associated with this contact.
➥ name	object	true	none	Full name.
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	true	none	Phone number.
➥ updatedAt	string(date-time)	false	none	Time this entity was last updated.
doNotSellOrShareUpdatedAt	string(date-time)	false	none	Time which the doNotSellOrShare was updated. This value would be null if the buyer never configured a doNotSellOrShare preference.
updatedAt	string(date-time)	true	none	Time this entity was last updated.

Enumerated Values

Value
Firm
GeneralDelivery
HighRise
POBox
RuralRoute
Street
NoMatch
InternationalNone
InternationalAdministrativeArea
InternationalLocality
InternationalThoroughfare
InternationalPremise
InternationalDeliveryPoint
Other

PRIMARY
HOME
WORK
OTHER
BILLING
SHIPPING

Firm
GeneralDelivery
HighRise
POBox
RuralRoute
Street
NoMatch
InternationalNone
InternationalAdministrativeArea
InternationalLocality
InternationalThoroughfare
InternationalPremise
InternationalDeliveryPoint
Other

PRIMARY
HOME
WORK
OTHER
BILLING
SHIPPING