Lead

Properties

lead_id string
Must be a UUID. The unique identifier of the lead.

type string
The lead's entity type, either individual or company.

id object
null is allowed. Object containing the lead's identification number, type and country.

type string
Either id or passport.

number string
The ID or passport number.

country string
The ISO Alpha-2 country code of the country of the id/passport number.

expiration_date string
null is allowed. The expiration date of the lead's passport.

date_of_birth string
null is allowed. The lead's date of birth.

gender string
null is allowed. The lead's gender (male or female).

first_name string
The lead's legal first name.

middle_name string
null is allowed. The lead's legal middle name.

last_name string
The lead's legal last name.

email string
null is allowed. The lead's contact email address.

cellphone string
null is allowed. The lead's contact cellphone number.

phone_other string
null is allowed. The lead's alternative phone number.

created_at string
The time at which the lead was created.

updated_at string
The time at which the lead was updated.

updated_by object
An object indicating the user or API key that updated the lead. See Authentication.

app_data object
null is allowed. An object containing additional custom data for the lead.

created_by object
An object indicating the user or API key that created the lead. See Authentication.

address object
null is allowed. The lead's physical address. See below for more details.

line_1 string
First line of the lead's address.

line_2 string
null is allowed. Optional second line of the lead's address.

suburb string
The lead's suburb.

city string
The lead's city.

country string
The lead's country code, in the ISO Alpha-2 format.

area_code string
The lead's area code, must be 4 characters long.

Example

{
  "lead_id": "bf1ada91-eecb-4f47-9bfa-1258bb1e0055",
  "type": "individual",
  "first_name": "Erlich",
  "middle_name": "Aviato",
  "last_name": "Bachman",
  "id": {
    "type": "id",
    "number": "6801015800084",
    "country": "ZA"
  },
  "date_of_birth": "1968-01-01",
  "gender": "male",
  "email": "[email protected]",
  "cellphone": null,
  "phone_other": null,
  "created_at": "2017-10-12T15:47:34.281Z",
  "app_data": {
    "company": "Aviato"
  },
  "created_by": {
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "user"
  },
  "address": {
    "line_1": "5230 Penfield Avenue",
    "suburb": "Woodland Hills",
    "city": "Los Angeles",
    "country": "US",
    "area_code": "CA 91364"
  }
}