SUsurense
Licensees

Get my licensee

Retrieve the licensee associated with the currently authenticated user. Users are not required to be associated with a licensee; when none is linked the endpoint returns 204 No Content rather than an error.

get/licensees/me

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/licensees/me
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Response

The licensee associated with the authenticated user

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
namestring
licenseNumberstring
type'עמ' | 'חפ' | 'חצ'
idNumberstring
cellNumberstring
cellNumberFormattedstring
cellNumberUristring
cellNumberWhatsAppUristring
phoneNumberstring
phoneNumberFormattedstring
phoneNumberUristring
emailstring
operationContactNamestring
operationContactPhonestring
operationContactEmailstring
licenseType'יועץ_פנסיוני' | 'סוכן_סוכנות_ביטוח' | 'משווק_פנסיוני' | 'שותפות'
pensioniboolean
claliboolean
yamiboolean
signaturestring
mainLicenseeIdstring uuid
userIdstring uuid
activeboolean

Changes

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