Contacts either represent individual people or businesses and are used within Claimable to build a profile for each person or business relating to your claims. A given contact can belong to a company, in the case of an employee or staff, or it can belong to one or many claims, in the case of claimants, insured parties, third parties, witnesses, etc.

Contacts can also exist on their own, without being linked to any claim or company.

The `Contact` Object

Attribute	Data Type	Description
id	Integer	The unique ID for the contact given by Claimable.
is_business	Boolean	Default: false Indicates if this contact refers to an individual (false) or business (true)
first_name	String	Required - unless `is_business` is true. The first name of the contact. If `is_business` is true, this becomes the first name of the primary contact person for that business.
last_name	String	Required - unless `is_business` is true. The last name of the contact. If `is_business` is true, this becomes the last name of the primary contact person for that business.
business_name	String	Required - if `is_business` is true. The name of the business if `is_business` is true, indicating this contact is refers to a business entity rather than an individual. If `is_business` is false, the `business_name` refers to the business to which the individual is related to.
title	String	One of: `Mr`, `Mrs`, `Miss`, `Ms`, `Mx`, `Dr`, `Prof`, `Rev`, `Sir`, `Dame`, `Lord`, `Lady` The title/salutation of the contact.
middle_name	String	The middle name of the contact.
email	String	The email address of the contact. Must be a valid email address.
mobile_phone	String	The mobile/cell phone number of the contact.
home_phone	String	The home phone number of the contact.
work_phone	String	The work/office phone number of the contact.
preferred_contact_method	String	One of: `mobile_phone`, `home_phone`, `work_phone`, `email` Indicates which contact method is preferred by the contact.
address_line1	String	The first line of the contact's address
address_line2	String	The second line of the contact's address.
address_line3	String	The third line of the contact's address.
address_city	String	The town/city of the contact's address.
address_state	String	The state/county of the contact's address.
address_postcode	String	The postcode/zipcode of the contact's address.
address_country	String	Read Only The country of the contact's address. Set via `address_country_code`.
address_country_code	String	The ISO 3166-1 alpha-3 3-letter country code for the country of the contact's address (e.g. 'gbr' = United Kingdom). Sets `address_country`.
beneficiary_account_account_number	String	The account number of the contact's beneficiary bank account for the purpose of making payments.
beneficiary_account_bank_name	String	The name of the bank holding the contact's beneficiary bank account for the purpose of making payments.
beneficiary_account_holder_name	String	The bank account holder's name of the contact's beneficiary bank account for the purpose of making payments. Defaults to the contact's name if blank.
beneficiary_account_iban	String	The IBAN number of the contact's beneficiary bank account for the purpose of making payments.
beneficiary_account_sort_code	String	The sort code (UK/Ireland) of the contact's beneficiary bank account for the purpose of making payments.
beneficiary_account_swift_bic	String	The SWIFT/BIC of the contact's beneficiary bank account for the purpose of making payments.
contact_description	String	A description of this contact.
date_of_birth	Date Format: "YYYY-MM-DD"	The date of birth of the contact. Not applicable if `is_business` is true.
driving_license_no	String	The contact's driving license number. Not applicable if `is_business` is true.
identity_card_no	String	The contact's ID or passport number. Not applicable if `is_business` is true.
social_security_no	String	The contact's social security number, or other government/administrative reference. Not applicable if `is_business` is true.
gender	String	One of: `male`, `female`, `other` The gender of the contact. Not applicable if `is_business` is true.
marital_status	String	One of: `single`, `married`, `widowed`, `divorced`, `separated`, `co-habiting` The marital status of the contact. Not applicable if `is_business` is true.
occupation	String	The occupation/position of the contact. Not applicable if `is_business` is true.
website	String	The contact's personal or business website URL.
created_at	Timestamp	Read Only The date/time the contact was created.
updated_at	Timestamp	Read Only The date/time the contact was last updated.
created_by	Integer	Read Only The id of the user who created the contact.
updated_by	Integer	Read Only The id of the user who last updated the contact.

Example Contact Object

{
  "id": 123456,
  "first_name": "David",
  "last_name": "Mentmore",
  "is_business": false,
  "email": "[email protected]",
  "mobile_phone": "+44 7123 343111",
  "home_phone": "0207 333 2222",
  "work_phone": "0207 111 7777",
  "preferred_contact_method": "mobile_phone",
  "address_line1": "1 Mentmore Terrace",
  "address_line2": "",
  "address_line3": "",
  "address_city": "London",
  "address_state": "London",
  "address_postcode": "E8 3PN",
  "address_country": "United Kingdom",
  "address_country_code": "gbr",
  "beneficiary_account_account_number": "12345674",
  "beneficiary_account_bank_name": "HSBC",
  "beneficiary_account_holder_name": "David Mentmore",
  "beneficiary_account_iban": "GB26MIDL40051512345674",
  "beneficiary_account_sort_code": "400515",
  "beneficiary_account_swift_bic": "HBUKGB4BXXX",
  "contact_description": "Prefers to be contacted between 9am and 5pm, Mon-Fri.",
  "date_of_birth": "1953-04-26",
  "driving_license_no": "JF453ABCD453232",
  "identity_card_no": "10104020",
  "social_security_no": "AB102209",
  "gender": "male",
  "marital_status": "married",
  "occupation": "Managing Director",
  "website": "www.google.com",
  "created_at": "2020-07-08T11:42:29.584Z",
  "updated_at": "2020-12-01T10:02:51.120Z",
  "created_by": 123,
  "updated_by": 456
}

The Contact Object

The `Contact` Object