AT AppointmentTrader
Sign In
Online Now  

/v1/trusted_client/

Trusted Client member-home and invite-code endpoints.
GET

/v1/trusted_client/get_home

#
Return the signed-in user's Trusted Client home. Pending interview requests or account-linked interest take precedence and return benefits, stage-specific status and an existing request chat only. Otherwise requires TrustedClientPrivilegeEligible for the full advisor and invitation home. No target user parameter is accepted.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/trusted_client/get_home' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_get_home_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].PayloadTrustedClientHome Yes
$.oneOf[0].allOf[1].Payload.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].viewState = "pending" Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].pendingStagestring ["application","interest"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].statusobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].status.titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].status.bodystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].benefitsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].benefits[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].benefits[].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].benefits[].bodystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].benefits[].iconstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAvailableboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[0].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatAction.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[0].chatNoticestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].viewState = "full" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].pendingStage = null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAvailableboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHeadTrustedClientAdvisorProfileHead Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].titleTag = "h3" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].layout = "mobile" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].class = "trusted-client-advisor-profile-card" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].attributes.data-trusted-client-advisor-card = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].actionsPreset = "custom" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identityobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.avatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.firstOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.firstOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.firstOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.createdDateEpoch Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[2]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.lastOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.lastOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.lastOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].authorobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].selectedProfileImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].selectedBannerImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].identity.bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].viewerobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].viewer.isSelfboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].viewer.isAuthenticatedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].viewer.canEditProfile = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].labelsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].labels.followersstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].labels.followingstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].labels.followsYoustring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].labels.importancestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].eyebrowstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metricsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metrics[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metrics[].keystring ["trusted-client-advisor-volume","trusted-client-advisor-customers"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metrics[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metrics[].formattedValuestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metrics[].tone = "neutral" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].metrics[].clickable = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badgesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].stylestring No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].hrefstring No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].attributesobject No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].attributes.data-atv2-medal-viewer-open = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].attributes.data-medal-slugstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badges[].attributes.data-medal-namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].renderBadgeContainer = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].badgeContainerHiddenboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLineobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.show = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.targetFollowsViewerboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.canOpenFollowLists = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].trustLine.importanceClickable = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActionsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[] No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].tag = "a" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].tone = "secondary" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].attributes.data-atv2-inline-navigation-skip = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].mediaGalleryEnabled = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].showPresence = false Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].innerCircleURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributes.aria-labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributes.dir = "ltr" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorProfileHead.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorContactobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorContact.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorContact.phoneLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorContact.phoneURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatActionobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.attributesobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].chatAction.attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].advisorNoticestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].tipsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].tips[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].tips[].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].tips[].bodystring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].tips[].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].tips[].hrefstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].canCreateInviteCodesboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].defaultAdvisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].defaultAdvisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].defaultDiscountAnnual = 0 Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].canCreateboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].canDiscountInitiationboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].canDiscountAnnualboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].canDiscountboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].maySelectAdvisorboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].maxDiscountInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].maxDiscountAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].commissionInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[0].commissionAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorDefaults.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0]object YesUp to the 50 newest active and 50 newest redeemed invites owned by the caller. Counts describe returned lists; there is no endpoint pagination parameter.
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[] No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodesarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[] No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].activeCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].redeemedCountinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaultsobject Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.defaultAdvisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.defaultAdvisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.defaultDiscountAnnual = 0 Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.canCreateboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.canDiscountInitiationboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.canDiscountAnnualboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.canDiscountboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.maySelectAdvisorboolean Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.maxDiscountInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.maxDiscountAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.commissionInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[0].permissionDefaults.commissionAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.anyOf[1].creatorSummary.anyOf[1]array Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/get_home",
    "RequestUserAlias": "example-user",
    "Payload": {
        "viewState": "pending",
        "pendingStage": "application",
        "status": {
            "title": "synthetic-example",
            "body": "synthetic-example"
        },
        "benefits": [],
        "chatAvailable": false,
        "chatAction": {
            "class": "atv2-action-wrap",
            "label": "synthetic-example",
            "href": "synthetic-example",
            "attributes": {
                "data-trusted-client-pending-chat": true,
                "data-chat-id": 0,
                "data-chat-name": "synthetic-example",
                "data-chat-url": "synthetic-example"
            }
        },
        "chatNotice": "synthetic-example"
    }
}
Machine-readable endpoint documentation
GET

/v1/trusted_client/get_invite_preview

#
Preview safe Trusted Client invite terms and status for a code. Public-by-design: invite entry needs to show whether a code is usable before checkout; the payload excludes recipient identity and commission terms.

Parameters

NameTypeRequiredDefaultDescription
code string No "" Trusted Client invite code.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/trusted_client/get_invite_preview' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'code={{code}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_get_invite_preview_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.idinteger Yes
$.oneOf[0].allOf[1].Payload.baseInitiationCentsinteger Yes
$.oneOf[0].allOf[1].Payload.baseAnnualCentsinteger Yes
$.oneOf[0].allOf[1].Payload.discountedInitiationCentsinteger Yes
$.oneOf[0].allOf[1].Payload.discountedAnnualCentsinteger Yes
$.oneOf[0].allOf[1].Payload.advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.isValidboolean Yes
$.oneOf[0].allOf[1].Payload.statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.codestring Yes
$.oneOf[0].allOf[1].Payload.formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.messagestring Yes
$.oneOf[0].allOf[1].Payload.inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.checkoutURLstring Yes
$.oneOf[0].allOf[1].Payload.signinURLstring Yes
$.oneOf[0].allOf[1].Payload.actionURLstring Yes
$.oneOf[0].allOf[1].Payload.baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.expireTimestring Yes
$.oneOf[0].allOf[1].Payload.expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileCardHTMLstring Yes
$.oneOf[0].allOf[1].Payload.twoYearNoticestring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHeadTrustedClientAdvisorProfileHead Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].titleTag = "h3" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].layout = "mobile" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].class = "trusted-client-advisor-profile-card" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].attributes.data-trusted-client-advisor-card = true Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].actionsPreset = "custom" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identityobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aliasstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.avatarstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.firstOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.firstOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.firstOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.createdDateEpoch Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[2]null Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.lastOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.lastOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.lastOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].authorobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.aliasstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].selectedProfileImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].selectedBannerImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].identity.bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].viewerobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].viewer.isSelfboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].viewer.isAuthenticatedboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].viewer.canEditProfile = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].labelsobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].labels.followersstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].labels.followingstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].labels.followsYoustring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].labels.importancestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].eyebrowstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metricsarray Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metrics[]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metrics[].keystring ["trusted-client-advisor-volume","trusted-client-advisor-customers"] Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metrics[].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metrics[].formattedValuestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metrics[].tone = "neutral" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].metrics[].clickable = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badgesarray Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].titlestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].stylestring No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].hrefstring No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].attributesobject No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].attributes.data-atv2-medal-viewer-open = true Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].attributes.data-medal-slugstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badges[].attributes.data-medal-namestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].renderBadgeContainer = true Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].badgeContainerHiddenboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLineobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.show = true Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.targetFollowsViewerboolean Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.canOpenFollowLists = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].trustLine.importanceClickable = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActionsarray Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[] No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].tag = "a" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].tone = "secondary" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].attributes.data-atv2-inline-navigation-skip = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].hrefstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributesobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].mediaGalleryEnabled = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].showPresence = false Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].innerCircleURLstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributes.aria-labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributes.dir = "ltr" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].hrefstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributesobject Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.advisorProfileHead.anyOf[1]array Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/get_invite_preview",
    "RequestUserAlias": "example-user",
    "Payload": {
        "id": 0,
        "baseInitiationCents": 0,
        "baseAnnualCents": 0,
        "discountedInitiationCents": 0,
        "discountedAnnualCents": 0,
        "advisorUserID": 0,
        "isValid": false,
        "status": "invalid",
        "discountInitiationPercent": 0,
        "discountAnnualPercent": 0,
        "code": "synthetic-example",
        "formattedCode": "synthetic-example",
        "message": "synthetic-example",
        "inviteURL": "synthetic-example",
        "checkoutURL": "synthetic-example",
        "signinURL": "synthetic-example",
        "actionURL": "synthetic-example",
        "baseInitiationLabel": "synthetic-example",
        "baseAnnualLabel": "synthetic-example",
        "discountedInitiationLabel": "synthetic-example",
        "discountedAnnualLabel": "synthetic-example",
        "discountInitiationLabel": "synthetic-example",
        "discountAnnualLabel": "synthetic-example",
        "expireTime": "synthetic-example",
        "expireTimeLabel": "synthetic-example",
        "advisorAlias": "synthetic-example",
        "advisorLabel": "synthetic-example",
        "advisorProfileCardHTML": "synthetic-example",
        "twoYearNotice": "synthetic-example",
        "advisorDisplay": {
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "avatarEmoji": "synthetic-example",
            "profileImageUrl": "synthetic-example",
            "profileImageURL": "synthetic-example",
            "label": "synthetic-example",
            "profileUrl": "synthetic-example",
            "profileURL": "synthetic-example",
            "title": "synthetic-example",
            "customColor": "synthetic-example",
            "customTextColor": "synthetic-example",
            "avatarMode": "synthetic-example",
            "html": "synthetic-example",
            "id": 0,
            "userID": 0,
            "isRich": false,
            "profileImage": {
                "id": 0,
                "thumbUrl": "synthetic-example",
                "mediaUrl": "synthetic-example",
                "mediaType": "synthetic-example",
                "width": 0,
                "height": 0,
                "title": "synthetic-example",
                "isImage": false,
                "isEmbedded": false,
                "frame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                }
            },
            "medals": [],
            "className": "trusted-client-invite-advisor-user"
        },
        "advisorProfileHead": {
            "titleTag": "h3",
            "layout": "mobile",
            "class": "trusted-client-advisor-profile-card",
            "attributes": {
                "data-trusted-client-advisor-card": true
            },
            "actionsPreset": "custom",
            "identity": {
                "userID": 0,
                "importancePoints": 0,
                "followerCount": 0,
                "followingCount": 0,
                "alias": "synthetic-example",
                "avatar": "synthetic-example",
                "avatarEmoji": "synthetic-example",
                "profileURL": "synthetic-example",
                "firstOnlineEpoch": 0,
                "createdDateEpoch": 0,
                "lastOnlineEpoch": 0,
                "aboutPost": {
                    "id": 0,
                    "title": "synthetic-example",
                    "bodyPreview": "synthetic-example",
                    "url": "synthetic-example",
                    "createdDate": "synthetic-example",
                    "author": {
                        "id": 0,
                        "alias": "synthetic-example",
                        "avatarEmoji": "synthetic-example",
                        "profileUrl": "synthetic-example"
                    },
                    "board": {
                        "id": 0,
                        "name": "synthetic-example",
                        "slug": "synthetic-example",
                        "type": "synthetic-example"
                    },
                    "imageMediaCount": 0,
                    "media": [],
                    "selectedProfileImageMediaID": 0,
                    "selectedBannerImageMediaID": 0
                },
                "profileImageMedia": {
                    "id": 0,
                    "thumbUrl": "synthetic-example",
                    "mediaUrl": "synthetic-example",
                    "mediaType": "synthetic-example",
                    "width": 0,
                    "height": 0,
                    "title": "synthetic-example",
                    "isImage": false,
                    "isEmbedded": false,
                    "frame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    }
                },
                "profileImageFrame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                },
                "bannerImageMedia": {
                    "id": 0,
                    "thumbUrl": "synthetic-example",
                    "mediaUrl": "synthetic-example",
                    "mediaType": "synthetic-example",
                    "width": 0,
                    "height": 0,
                    "title": "synthetic-example",
                    "isImage": false,
                    "isEmbedded": false,
                    "frame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    }
                },
                "bannerImageFrame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                }
            },
            "viewer": {
                "isSelf": false,
                "isAuthenticated": false,
                "canEditProfile": false
            },
            "labels": {
                "followers": "synthetic-example",
                "following": "synthetic-example",
                "followsYou": "synthetic-example",
                "importance": "synthetic-example"
            },
            "eyebrow": "synthetic-example",
            "metrics": [],
            "badges": [],
            "renderBadgeContainer": true,
            "badgeContainerHidden": false,
            "trustLine": {
                "show": true,
                "followerCount": 0,
                "followingCount": 0,
                "importancePoints": 0,
                "targetFollowsViewer": false,
                "canOpenFollowLists": false,
                "importanceClickable": false
            },
            "secondaryActions": [],
            "mediaGalleryEnabled": false,
            "showPresence": false,
            "innerCircleURL": "synthetic-example"
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/trusted_client/get_invites

#
Return the authenticated user's Trusted Client invite-code management summary.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/trusted_client/get_invites' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_get_invites_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject YesUp to the 50 newest active and 50 newest redeemed invites owned by the caller. Counts describe returned lists; there is no endpoint pagination parameter.
$.oneOf[0].allOf[1].Payload.activeCodesarray Yes
$.oneOf[0].allOf[1].Payload.activeCodes[] No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.redeemedCodesarray Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[] No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.activeCountinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCountinteger Yes
$.oneOf[0].allOf[1].Payload.permissionDefaultsobject Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.defaultAdvisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.defaultAdvisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.defaultDiscountAnnual = 0 Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canCreateboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canDiscountInitiationboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canDiscountAnnualboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canDiscountboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.maySelectAdvisorboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.maxDiscountInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.maxDiscountAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.commissionInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.commissionAnnualnumber Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/get_invites",
    "RequestUserAlias": "example-user",
    "Payload": {
        "activeCodes": [],
        "redeemedCodes": [],
        "activeCount": 0,
        "redeemedCount": 0,
        "permissionDefaults": {
            "defaultAdvisorUserID": 0,
            "defaultAdvisorAlias": "synthetic-example",
            "defaultDiscountAnnual": 0,
            "canCreate": false,
            "canDiscountInitiation": false,
            "canDiscountAnnual": false,
            "canDiscount": false,
            "maySelectAdvisor": false,
            "maxDiscountInitiation": 0,
            "maxDiscountAnnual": 0,
            "commissionInitiation": 0,
            "commissionAnnual": 0
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/trusted_client/set_claim_invite_code

#
Claim a Trusted Client invite code for the signed-in user, or return a sign-in preview for a guest. Public-by-design: logged-out code entry must show the same safe terms and sign-in action without mutating the invite.

Parameters

NameTypeRequiredDefaultDescription
code string No "" Trusted Client invite code.
isWritingRequest bool No false Set true to claim the invite when the caller is signed in.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/trusted_client/set_claim_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'code={{code}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_set_claim_invite_code_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.inviteobject Yes
$.oneOf[0].allOf[1].Payload.invite.idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.baseInitiationCentsinteger Yes
$.oneOf[0].allOf[1].Payload.invite.baseAnnualCentsinteger Yes
$.oneOf[0].allOf[1].Payload.invite.discountedInitiationCentsinteger Yes
$.oneOf[0].allOf[1].Payload.invite.discountedAnnualCentsinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.invite.isValidboolean Yes
$.oneOf[0].allOf[1].Payload.invite.statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.invite.discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.codestring Yes
$.oneOf[0].allOf[1].Payload.invite.formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.invite.messagestring Yes
$.oneOf[0].allOf[1].Payload.invite.inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.checkoutURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.signinURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.actionURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.expireTimestring Yes
$.oneOf[0].allOf[1].Payload.invite.expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileCardHTMLstring Yes
$.oneOf[0].allOf[1].Payload.invite.twoYearNoticestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHeadTrustedClientAdvisorProfileHead Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].titleTag = "h3" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].layout = "mobile" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].class = "trusted-client-advisor-profile-card" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].attributes.data-trusted-client-advisor-card = true Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].actionsPreset = "custom" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identityobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aliasstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.avatarstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.firstOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.firstOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.firstOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.createdDateEpoch Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.createdDateEpoch.anyOf[2]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.lastOnlineEpoch Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.lastOnlineEpoch.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.lastOnlineEpoch.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].bodyPreviewstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].urlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].authorobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.aliasstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].author.profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].boardobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.namestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.slugstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].board.typestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].imageMediaCountinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].mediaarray Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].widthinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].heightinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].media[].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].selectedProfileImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[0].selectedBannerImageMediaIDinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.aboutPost.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.profileImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageMedia.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageFrameobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageFrame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageFrame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].identity.bannerImageFrame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].viewerobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].viewer.isSelfboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].viewer.isAuthenticatedboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].viewer.canEditProfile = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].labelsobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].labels.followersstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].labels.followingstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].labels.followsYoustring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].labels.importancestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].eyebrowstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metricsarray Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metrics[]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metrics[].keystring ["trusted-client-advisor-volume","trusted-client-advisor-customers"] Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metrics[].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metrics[].formattedValuestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metrics[].tone = "neutral" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].metrics[].clickable = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badgesarray Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].titlestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].stylestring No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].hrefstring No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].attributesobject No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].attributes.data-atv2-medal-viewer-open = true Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].attributes.data-medal-slugstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badges[].attributes.data-medal-namestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].renderBadgeContainer = true Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].badgeContainerHiddenboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLineobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.show = true Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.followerCountinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.followingCountinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.importancePointsinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.targetFollowsViewerboolean Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.canOpenFollowLists = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].trustLine.importanceClickable = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActionsarray Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[] No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].tag = "a" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].tone = "secondary" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[0].attributes.data-atv2-inline-navigation-skip = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].hrefstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributesobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].secondaryActions[].anyOf[1].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].mediaGalleryEnabled = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].showPresence = false Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].innerCircleURLstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[0]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].hrefstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributesobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributes.aria-labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[0].attributes.dir = "ltr" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1]object No
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].class = "atv2-action-wrap" Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].hrefstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributesobject Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-trusted-client-pending-chat = true Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-idinteger Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-namestring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[0].primaryAction.anyOf[1].attributes.data-chat-urlstring Yes
$.oneOf[0].allOf[1].Payload.invite.advisorProfileHead.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.claimedInvite Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.claimedInvite.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/set_claim_invite_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "invite": {
            "id": 0,
            "baseInitiationCents": 0,
            "baseAnnualCents": 0,
            "discountedInitiationCents": 0,
            "discountedAnnualCents": 0,
            "advisorUserID": 0,
            "isValid": false,
            "status": "invalid",
            "discountInitiationPercent": 0,
            "discountAnnualPercent": 0,
            "code": "synthetic-example",
            "formattedCode": "synthetic-example",
            "message": "synthetic-example",
            "inviteURL": "synthetic-example",
            "checkoutURL": "synthetic-example",
            "signinURL": "synthetic-example",
            "actionURL": "synthetic-example",
            "baseInitiationLabel": "synthetic-example",
            "baseAnnualLabel": "synthetic-example",
            "discountedInitiationLabel": "synthetic-example",
            "discountedAnnualLabel": "synthetic-example",
            "discountInitiationLabel": "synthetic-example",
            "discountAnnualLabel": "synthetic-example",
            "expireTime": "synthetic-example",
            "expireTimeLabel": "synthetic-example",
            "advisorAlias": "synthetic-example",
            "advisorLabel": "synthetic-example",
            "advisorProfileCardHTML": "synthetic-example",
            "twoYearNotice": "synthetic-example",
            "advisorDisplay": {
                "alias": "synthetic-example",
                "avatar": "synthetic-example",
                "avatarEmoji": "synthetic-example",
                "profileImageUrl": "synthetic-example",
                "profileImageURL": "synthetic-example",
                "label": "synthetic-example",
                "profileUrl": "synthetic-example",
                "profileURL": "synthetic-example",
                "title": "synthetic-example",
                "customColor": "synthetic-example",
                "customTextColor": "synthetic-example",
                "avatarMode": "synthetic-example",
                "html": "synthetic-example",
                "id": 0,
                "userID": 0,
                "isRich": false,
                "profileImage": {
                    "id": 0,
                    "thumbUrl": "synthetic-example",
                    "mediaUrl": "synthetic-example",
                    "mediaType": "synthetic-example",
                    "width": 0,
                    "height": 0,
                    "title": "synthetic-example",
                    "isImage": false,
                    "isEmbedded": false,
                    "frame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    }
                },
                "medals": [],
                "className": "trusted-client-invite-advisor-user"
            },
            "advisorProfileHead": {
                "titleTag": "h3",
                "layout": "mobile",
                "class": "trusted-client-advisor-profile-card",
                "attributes": {
                    "data-trusted-client-advisor-card": true
                },
                "actionsPreset": "custom",
                "identity": {
                    "userID": 0,
                    "importancePoints": 0,
                    "followerCount": 0,
                    "followingCount": 0,
                    "alias": "synthetic-example",
                    "avatar": "synthetic-example",
                    "avatarEmoji": "synthetic-example",
                    "profileURL": "synthetic-example",
                    "firstOnlineEpoch": 0,
                    "createdDateEpoch": 0,
                    "lastOnlineEpoch": 0,
                    "aboutPost": {
                        "id": 0,
                        "title": "synthetic-example",
                        "bodyPreview": "synthetic-example",
                        "url": "synthetic-example",
                        "createdDate": "synthetic-example",
                        "author": {
                            "id": 0,
                            "alias": "synthetic-example",
                            "avatarEmoji": "synthetic-example",
                            "profileUrl": "synthetic-example"
                        },
                        "board": {
                            "id": 0,
                            "name": "synthetic-example",
                            "slug": "synthetic-example",
                            "type": "synthetic-example"
                        },
                        "imageMediaCount": 0,
                        "media": [],
                        "selectedProfileImageMediaID": 0,
                        "selectedBannerImageMediaID": 0
                    },
                    "profileImageMedia": {
                        "id": 0,
                        "thumbUrl": "synthetic-example",
                        "mediaUrl": "synthetic-example",
                        "mediaType": "synthetic-example",
                        "width": 0,
                        "height": 0,
                        "title": "synthetic-example",
                        "isImage": false,
                        "isEmbedded": false,
                        "frame": {
                            "positionXPercent": 0,
                            "positionYPercent": 0,
                            "zoomPercent": 100
                        }
                    },
                    "profileImageFrame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    },
                    "bannerImageMedia": {
                        "id": 0,
                        "thumbUrl": "synthetic-example",
                        "mediaUrl": "synthetic-example",
                        "mediaType": "synthetic-example",
                        "width": 0,
                        "height": 0,
                        "title": "synthetic-example",
                        "isImage": false,
                        "isEmbedded": false,
                        "frame": {
                            "positionXPercent": 0,
                            "positionYPercent": 0,
                            "zoomPercent": 100
                        }
                    },
                    "bannerImageFrame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    }
                },
                "viewer": {
                    "isSelf": false,
                    "isAuthenticated": false,
                    "canEditProfile": false
                },
                "labels": {
                    "followers": "synthetic-example",
                    "following": "synthetic-example",
                    "followsYou": "synthetic-example",
                    "importance": "synthetic-example"
                },
                "eyebrow": "synthetic-example",
                "metrics": [],
                "badges": [],
                "renderBadgeContainer": true,
                "badgeContainerHidden": false,
                "trustLine": {
                    "show": true,
                    "followerCount": 0,
                    "followingCount": 0,
                    "importancePoints": 0,
                    "targetFollowsViewer": false,
                    "canOpenFollowLists": false,
                    "importanceClickable": false
                },
                "secondaryActions": [],
                "mediaGalleryEnabled": false,
                "showPresence": false,
                "innerCircleURL": "synthetic-example"
            }
        },
        "claimedInvite": {
            "id": 0,
            "recipientUserID": 0,
            "advisorUserID": 0,
            "issuerUserID": 0,
            "redeemedByUserID": 0,
            "applicationLedgerID": 0,
            "discountInitiationPercent": 0,
            "discountAnnualPercent": 0,
            "commissionInitiationPercent": 0,
            "commissionAnnualPercent": 0,
            "code": "synthetic-example",
            "formattedCode": "synthetic-example",
            "inviteURL": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdDateLabel": "synthetic-example",
            "expireTime": "synthetic-example",
            "expireTimeLabel": "synthetic-example",
            "recipientAlias": "synthetic-example",
            "recipientEmail": "synthetic-example",
            "recipientLabel": "synthetic-example",
            "recipientAvatar": "synthetic-example",
            "recipientProfileURL": "synthetic-example",
            "advisorAlias": "synthetic-example",
            "advisorLabel": "synthetic-example",
            "issuerAlias": "synthetic-example",
            "discountInitiationLabel": "synthetic-example",
            "discountAnnualLabel": "synthetic-example",
            "commissionInitiationLabel": "synthetic-example",
            "commissionAnnualLabel": "synthetic-example",
            "baseInitiationLabel": "synthetic-example",
            "baseAnnualLabel": "synthetic-example",
            "discountedInitiationLabel": "synthetic-example",
            "discountedAnnualLabel": "synthetic-example",
            "redeemedByAlias": "synthetic-example",
            "redeemedByAvatar": "synthetic-example",
            "redeemedByProfileURL": "synthetic-example",
            "redeemedDate": "synthetic-example",
            "redeemedDateLabel": "synthetic-example",
            "statusLabel": "synthetic-example",
            "status": "invalid",
            "advisorDisplay": {
                "alias": "synthetic-example",
                "avatar": "synthetic-example",
                "avatarEmoji": "synthetic-example",
                "profileImageUrl": "synthetic-example",
                "profileImageURL": "synthetic-example",
                "label": "synthetic-example",
                "profileUrl": "synthetic-example",
                "profileURL": "synthetic-example",
                "title": "synthetic-example",
                "customColor": "synthetic-example",
                "customTextColor": "synthetic-example",
                "avatarMode": "synthetic-example",
                "html": "synthetic-example",
                "id": 0,
                "userID": 0,
                "isRich": false,
                "profileImage": {
                    "id": 0,
                    "thumbUrl": "synthetic-example",
                    "mediaUrl": "synthetic-example",
                    "mediaType": "synthetic-example",
                    "width": 0,
                    "height": 0,
                    "title": "synthetic-example",
                    "isImage": false,
                    "isEmbedded": false,
                    "frame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    }
                },
                "medals": [],
                "className": "trusted-client-invite-advisor-user"
            }
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/trusted_client/set_create_invite_code

#
Create an unclaimed Trusted Client invite code. The signed-in person who enters the code claims it and becomes tied to the creator.

Parameters

NameTypeRequiredDefaultDescription
expireTime string No "" Future expiry date/time.
discountPercentInitiation float No 0 Initiation discount percent, capped by TrustedClientMaxDiscountPercentInitiation.
discountPercentAnnual float No 0 Annual-fee discount percent, capped by TrustedClientDiscountPercentAnnual.
advisorUserAlias string No "" Optional selected advisor alias when TrustedClientMaySelectAdvisor is granted. When blank, active Trusted Clients use their assigned advisor; otherwise unassigned.
isWritingRequest bool No false Set true to actually create the invite code.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/trusted_client/set_create_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'expireTime={{expireTime}}' \
  --data-urlencode 'discountPercentInitiation={{discountPercentInitiation}}' \
  --data-urlencode 'discountPercentAnnual={{discountPercentAnnual}}' \
  --data-urlencode 'advisorUserAlias={{advisorUserAlias}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_set_create_invite_code_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.createdInvite Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.createdInvite.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.inviteSummaryobject YesUp to the 50 newest active and 50 newest redeemed invites owned by the caller. Counts describe returned lists; there is no endpoint pagination parameter.
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodesarray Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[] No
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodesarray Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[] No
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.inviteSummary.activeCountinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.redeemedCountinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaultsobject Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.defaultAdvisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.defaultAdvisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.defaultDiscountAnnual = 0 Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.canCreateboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.canDiscountInitiationboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.canDiscountAnnualboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.canDiscountboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.maySelectAdvisorboolean Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.maxDiscountInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.maxDiscountAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.commissionInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.inviteSummary.permissionDefaults.commissionAnnualnumber Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/set_create_invite_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "createdInvite": {
            "id": 0,
            "recipientUserID": 0,
            "advisorUserID": 0,
            "issuerUserID": 0,
            "redeemedByUserID": 0,
            "applicationLedgerID": 0,
            "discountInitiationPercent": 0,
            "discountAnnualPercent": 0,
            "commissionInitiationPercent": 0,
            "commissionAnnualPercent": 0,
            "code": "synthetic-example",
            "formattedCode": "synthetic-example",
            "inviteURL": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdDateLabel": "synthetic-example",
            "expireTime": "synthetic-example",
            "expireTimeLabel": "synthetic-example",
            "recipientAlias": "synthetic-example",
            "recipientEmail": "synthetic-example",
            "recipientLabel": "synthetic-example",
            "recipientAvatar": "synthetic-example",
            "recipientProfileURL": "synthetic-example",
            "advisorAlias": "synthetic-example",
            "advisorLabel": "synthetic-example",
            "issuerAlias": "synthetic-example",
            "discountInitiationLabel": "synthetic-example",
            "discountAnnualLabel": "synthetic-example",
            "commissionInitiationLabel": "synthetic-example",
            "commissionAnnualLabel": "synthetic-example",
            "baseInitiationLabel": "synthetic-example",
            "baseAnnualLabel": "synthetic-example",
            "discountedInitiationLabel": "synthetic-example",
            "discountedAnnualLabel": "synthetic-example",
            "redeemedByAlias": "synthetic-example",
            "redeemedByAvatar": "synthetic-example",
            "redeemedByProfileURL": "synthetic-example",
            "redeemedDate": "synthetic-example",
            "redeemedDateLabel": "synthetic-example",
            "statusLabel": "synthetic-example",
            "status": "invalid",
            "advisorDisplay": {
                "alias": "synthetic-example",
                "avatar": "synthetic-example",
                "avatarEmoji": "synthetic-example",
                "profileImageUrl": "synthetic-example",
                "profileImageURL": "synthetic-example",
                "label": "synthetic-example",
                "profileUrl": "synthetic-example",
                "profileURL": "synthetic-example",
                "title": "synthetic-example",
                "customColor": "synthetic-example",
                "customTextColor": "synthetic-example",
                "avatarMode": "synthetic-example",
                "html": "synthetic-example",
                "id": 0,
                "userID": 0,
                "isRich": false,
                "profileImage": {
                    "id": 0,
                    "thumbUrl": "synthetic-example",
                    "mediaUrl": "synthetic-example",
                    "mediaType": "synthetic-example",
                    "width": 0,
                    "height": 0,
                    "title": "synthetic-example",
                    "isImage": false,
                    "isEmbedded": false,
                    "frame": {
                        "positionXPercent": 0,
                        "positionYPercent": 0,
                        "zoomPercent": 100
                    }
                },
                "medals": [],
                "className": "trusted-client-invite-advisor-user"
            }
        },
        "inviteSummary": {
            "activeCodes": [],
            "redeemedCodes": [],
            "activeCount": 0,
            "redeemedCount": 0,
            "permissionDefaults": {
                "defaultAdvisorUserID": 0,
                "defaultAdvisorAlias": "synthetic-example",
                "defaultDiscountAnnual": 0,
                "canCreate": false,
                "canDiscountInitiation": false,
                "canDiscountAnnual": false,
                "canDiscount": false,
                "maySelectAdvisor": false,
                "maxDiscountInitiation": 0,
                "maxDiscountAnnual": 0,
                "commissionInitiation": 0,
                "commissionAnnual": 0
            }
        }
    }
}
Machine-readable endpoint documentation
POST

/v1/trusted_client/set_register_interest

#
Register interest in Trusted Client access for a logged-in user or guest email. Public-by-design: no-code visitors need a lightweight way to express interest without an invite.

Parameters

NameTypeRequiredDefaultDescription
email string No "" Guest email address. Logged-in users may leave this blank.
isWritingRequest bool No false Set true to save the interest.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/trusted_client/set_register_interest' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'email={{email}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_set_register_interest_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.registered = true Yes
$.oneOf[0].allOf[1].Payload.idinteger Yes
$.oneOf[0].allOf[1].Payload.createdDatestring Yes
$.oneOf[0].allOf[1].Payload.lastUpdateDatestring Yes
$.oneOf[0].allOf[1].Payload.notifiedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.titlestring Yes
$.oneOf[0].allOf[1].Payload.messagestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/set_register_interest",
    "RequestUserAlias": "example-user",
    "Payload": {
        "registered": true,
        "id": 0,
        "createdDate": "synthetic-example",
        "lastUpdateDate": "synthetic-example",
        "notifiedDateLabel": "synthetic-example",
        "title": "synthetic-example",
        "message": "synthetic-example"
    }
}
Machine-readable endpoint documentation
POST

/v1/trusted_client/set_revoke_invite_code

#
Revoke an unused Trusted Client invite code owned by the authenticated creator.

Parameters

NameTypeRequiredDefaultDescription
inviteCodeID int Yes — Invite code ID from get_invites.
isWritingRequest bool No false Set true to actually revoke the invite code.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/trusted_client/set_revoke_invite_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'inviteCodeID={{inviteCodeID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$trusted_client_set_revoke_invite_code_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject YesUp to the 50 newest active and 50 newest redeemed invites owned by the caller. Counts describe returned lists; there is no endpoint pagination parameter.
$.oneOf[0].allOf[1].Payload.activeCodesarray Yes
$.oneOf[0].allOf[1].Payload.activeCodes[] No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.activeCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.redeemedCodesarray Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[] No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].issuerUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].applicationLedgerIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionInitiationPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionAnnualPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].codestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].formattedCodestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].inviteURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].createdDatestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].createdDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].expireTimestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].expireTimeLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientEmailstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientAvatarstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].recipientProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].issuerAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].commissionAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].baseInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].baseAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountedInitiationLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].discountedAnnualLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByAliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByAvatarstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedByProfileURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedDatestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].redeemedDateLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].statusstring ["invalid","revoked","redeemed","expired","signin_required","wrong_recipient","two_year_window","valid"] Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplayTrustedClientAdvisorDisplay Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].aliasstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customColorstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].customTextColorstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].avatarModestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].htmlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].isRichboolean Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medalsarray Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[]object No
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].Namestring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].medals[].URLstring Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[0].className = "trusted-client-invite-advisor-user" Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[0].advisorDisplay.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.redeemedCodes[].anyOf[1]null No
$.oneOf[0].allOf[1].Payload.activeCountinteger Yes
$.oneOf[0].allOf[1].Payload.redeemedCountinteger Yes
$.oneOf[0].allOf[1].Payload.permissionDefaultsobject Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.defaultAdvisorUserIDinteger Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.defaultAdvisorAliasstring Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.defaultDiscountAnnual = 0 Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canCreateboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canDiscountInitiationboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canDiscountAnnualboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.canDiscountboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.maySelectAdvisorboolean Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.maxDiscountInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.maxDiscountAnnualnumber Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.commissionInitiationnumber Yes
$.oneOf[0].allOf[1].Payload.permissionDefaults.commissionAnnualnumber Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/trusted_client/set_revoke_invite_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "activeCodes": [],
        "redeemedCodes": [],
        "activeCount": 0,
        "redeemedCount": 0,
        "permissionDefaults": {
            "defaultAdvisorUserID": 0,
            "defaultAdvisorAlias": "synthetic-example",
            "defaultDiscountAnnual": 0,
            "canCreate": false,
            "canDiscountInitiation": false,
            "canDiscountAnnual": false,
            "canDiscount": false,
            "maySelectAdvisor": false,
            "maxDiscountInitiation": 0,
            "maxDiscountAnnual": 0,
            "commissionInitiation": 0,
            "commissionAnnual": 0
        }
    }
}
Machine-readable endpoint documentation