SUsurense
Customers

Get a customer

Retrieve a specific customer by its UUID.

get/customers/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/customers/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: customers:read

Path parameters

idstring uuid required

Customer UUID

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
duplicateboolean
statusIdstring uuid
statusNamestring
statusActiveboolean
sourceIdstring uuid
sourceNamestring
customerClassIdstring uuid
classIdstring uuid
classNamestring
managerIdstring uuid
managersstring[]
sensitiveboolean
mailingStatus1 | 2 | 3 | 4

Mailing Status:<br/>1 - אושר דיוור<br/>2 - לא אושר דיוור<br/>3 - הוסר מדיוור<br/>4 - לא התבקש אישור

mailingStatusDatestring date-time
idType1 | 2 | 3 | 4 | 5 | 6

Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ

idNumberstring
idNumberLockedboolean
idCardIssueDatestring date
firstNamestring
shortNamestring
lastNamestring
fullNamestring
fullNameReversestring
maidenNamestring
engFirstNamestring
engLastNamestring
cellNumberstring
cellNumberVerifiedboolean
cellNumberFormattedstring
cellNumberUristring
cellNumberWhatsAppUristring
phoneNumberstring
phoneNumberFormattedstring
phoneNumberUristring
phoneNumberWhatsAppUristring
phoneNumber2string
phoneNumber2Formattedstring
phoneNumber2Uristring
phoneNumber2WhatsAppUristring
phoneNumber3string
phoneNumber3Formattedstring
phoneNumber3Uristring
phoneNumber3WhatsAppUristring
faxNumberstring
faxNumberFormattedstring
faxNumberUristring
emailstring
emailBounceboolean
emailComplaintboolean
otherEmailstring
gender1 | 2 | 3

Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה

birthDatestring date
birthDayinteger
birthMonthinteger
birthYearinteger
birthDateYearOnlyboolean
agestring
minorboolean
deathboolean
deathDatestring date
streetstring
streetNumberstring
apartmentNumberstring
postalBoxinteger
citystring
postalCodeinteger
countrystring
addressstring
maritalStatus1 | 2 | 3 | 4 | 5

Marital Status:<br/>1 - רווק/ה<br/>2 - נשוי/אה<br/>3 - גרוש/ה<br/>4 - אלמן/ה<br/>5 - ידוע/ה בציבור

childrenCountinteger
partnerIdstring uuid
partnerNamestring
professionstring
employmentStatus1 | 2 | 3 | 4 | 5 | 6 | 7

Employment Status:<br/>1 - שכיר/ה<br/>2 - עצמאי/ת<br/>3 - שכיר/ה ועצמאי/ת<br/>4 - שכיר/ה בעל/ת שליטה<br/>5 - לא מועסק/ת<br/>6 - שכיר/ה בעל/ת שליטה ועצמאי/ת<br/>7 - פנסיונר/ית

employerId1string uuid
employerName1string
employmentIncome1integer
employerId2string uuid
employerName2string
employmentIncome2integer
usCitizenboolean
foreignTaxResidencyboolean
engAddressstring
kupatHolim1 | 2 | 3 | 4 | 5

Kupat Holim:<br/>1 - כללית<br/>2 - מכבי<br/>3 - מאוחדת<br/>4 - לאומית<br/>5 - צה"לית

kupatHolimComplementary10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41

Kupat Holim Complementary:<br/>10 - כללית מושלם זהב<br/>11 - כללית פלטינום<br/>20 - מכבי שלי<br/>21 - מכבי כסף<br/>22 - מכבי זהב<br/>30 - מאוחדת עדיף<br/>31 - מאוחדת שיא<br/>40 - לאומית כסף<br/>41 - לאומית זהב

heightinteger
weightinteger
smokerboolean
cigarettesCountPerDayinteger
drugsstring
surgeriesstring
hospitalizationsstring
backgroundDiseasesstring
bankAccountTypestring
bankCodeinteger
bankBranchCodeinteger
bankAccountNumberstring
swiftnessProxyInviteDatestring date
swiftnessProxySignDatestring date
swiftnessProxyExpiryDatestring date
swiftnessProxyExpiredboolean
lastE9100DataDatestring date
outdatedE9100Databoolean
swiftnessDataboolean
hbProxyInviteDatestring date
hbProxySignDatestring date
hbProxyExpiryDatestring date
hbProxyExpiredboolean
hbDataDatestring date
policiesProxyInviteDatestring date
policiesProxySignDatestring date
policiesProxyExpiryDatestring date
policiesProxyExpiredboolean
lastSwiftnessProductiaMonthstring
lastPratProductiaMonthstring
lastProductiaMonthstring
notesstring
notesUpdatedBystring uuid
notesUpdatedAtstring date-time
notesAlertboolean
reportEnabledboolean
reportPeriod'חד_פעמי' | 'חודשי' | 'רבעוני' | 'חצי_שנתי' | 'שנתי'
reportFormat'ממשק_אינטרנטי' | 'PDF'
reportByEmailboolean
reportByCellNumberboolean
reportIncludesInvestmentProductsboolean
reportIncludesInsuranceProductsboolean
reportDetailType1 | 2 | 3
reportFamilyboolean
reportFamilyDatestring date-time
reportFamilyExpiryDatestring date-time
reportFamilyExpiredboolean
lastSentConsultingReportIdstring uuid
lastSentConsultingReportTimestampstring date-time
lastSentProductiaReportIdstring uuid
lastSentProductiaReportTimestampstring date-time
lastProductiaReportAccessDatestring date-time
lastActivityDatestring date-time
lastActivityBystring uuid
lastMeetingDatestring date
monthlyRevenuenumber
appMailAddressstring
customerServiceEnabledboolean
customerServiceRecurrence1 | 2 | 3 | 4
customerServiceSmsboolean
customerServiceEmailboolean
tagsstring[]
surenseOneActiveboolean

Changes

No recorded changes to this operation across all 1 revision of this API.