Session API

session api enables investment firms to access data of investment advice sessions and order execution sessions data collected by the advisor through deepalpha and suggested saving plan/order, can be integrated into existing systems such integration streamlines dataflow securely, increase efficiency and reduces friction for advisors key use cases enabled by session api extract information about suggested saving plan and automatically update your portfolio system to prepare orders for execution extract advice information and store it in your data warehouse for further data analysis session object returned by session get call this json file represents a record of an information collected throughout a session in deep alpha it might include information about the investor, advice information, purpose and risk, knowledge and experience, financial situation, sustainability preferences, and details about the suggest investment plan data structure the json file consists of several objects with various properties adviceinformation an array of objects that contains information about questions from the advice information page in deep alpha this will be empty if the page is not in use fieldname the name of the field related to the advice information value the value associated with the field advisornote the advisors note in regard to collecting advice information placeholder advisor an object that contains information about advisor that has given this advice email a string that contains advisors email address id a string that defines a unique identifier for an advisor name a string that defines an advisors name advisornotes a string that contains any notes or comments made by the advisor during the meeting this field defines what was the reasoning for advice channel a string that contains the channel through which the advisory meeting was conducted possible values tenants office phone online other completedat a string that contains the date and time when the advisory meeting was completed, or null if it has not yet been completed createdat a string that contains the date and time when the advisory meeting was created customknowledgeandexperiencefields an array of objects that contain information about custom fields that were set up by the tenant for knowledge and experience page fieldname a name of the custom field value a value submitted to custom field during a session executed a boolean value that indicates whether or not the investment advice has been executed this field is patched by tenants to indicate that this advice session has been finished and resulted in purchase of instrument shares more about session api docid\ kk3rlqw8kqxu1x ovb4of financialsituation an object that contains information about client's financial situation it is highly configurable and defines asset / sub asset classes and/or debt and its classes below there are examples of asset class cash and debt class mortgage moreover this section might include custom fields those fields should be in this indentation of a payload and be a key / value pair cash an object that contains information about the client's cash assets defaultvalue the default value for the client's cash assets details an array of objects that contain details about the client's cash assets, including their id, title, value, and whether they are to be advised on id a unique identifier for the cash details item title a string that defines what is that cash position name toadvisory a number that defines how much of the cash will be used for advisory value a number that defines how much cash is in a given position toadvisory the total value of the client's cash assets to be advised on mortgage an object that contains information about the client's mortgage defaultvalue the default value for the client's mortgage toadvisory the total value of the client's mortgage to be advised on advisornote a string that contains any notes or comments made by the advisor during the meeting this field defines financial situation page note placeholder goals an array of objects that contain information about the client's investment goals, including the amount they want to invest and the time horizon for their investment advisedportfolio an array that contains information about the advised portfolio related to the goal mainassetclass a string that represents the main asset class of the advised portfolio subassetclass a string that represents the sub asset class of the advised portfolio weight a string that represents the weight of the advised portfolio instruments an array that contains information about the instruments in the advised portfolio id a string that represents a unique identifier for the instrument title a string that represents the title of the instrument weight a string that represents the weight of the instrument suitabilityassessment an object that contains information about the suitability assessment for the instrument productissuitable a boolean value that indicates whether the product is suitable details an array that contains details of the suitability assessment checkid a number that represents the identifier for the suitability check checkkey a string that represents the key for the suitability check score a number that represents the score for the suitability check threshold a number that represents the threshold for the suitability check assetclassallocationadvisornote a string that defines what was the advisor note for asset class allocation added by an advisor capitalneed the client's capital need for their investment goals only available when tenant is using cashflow customportfolio a boolean value that indicates whether or not the client has a custom investment portfolio description a string that contains a description of the client's investment goals firstdeposit the amount of the client's first deposit towards their investment goals fundallocationadvisornote a string that defines what was the advisor note for fund allocation added by an advisor id a unique identifier for the client's investment goals isportfoliocustom a boolean value that indicates whether or not the client's investment portfolio is custom monthlydeposit the amount of the client's monthly deposit towards their investment goals name a string that contains the name of the client's investment goals portfolio a string that contains the id of the client's investment portfolio productplatform an object that contains information about the client's investment product platform namespaceid the namespace id for the client's investment product platform productplatformreasoning a string that contains the reasoning behind the client's investment product platform questions an object that contains questions related to the client's investment product platform riskscore a string that defines risk level assigned to an investor themes a string that contains the themes associated with the client's investment goals timehorizon the time horizon for the client's investment goals type a string that defines type of a goal withdrawalplan an integer that defines how this goal should be withdrawn id a string that contains a unique identifier for the investment advisory meeting investordata an object that contains information about the investor, including their name, contact details, and kyc (know your customer) information address the investor's address advisorid a string that contains a unique identifier for the advisor providing the investment advice advisorname the name of the advisor providing the investment advice city the investor's city country the investor's country customfields custom fields related to the investor email the investor's email address externalid a unique identifier for the investor id a string that contains a unique identifier for the investor kyc an object that contains kyc (know your customer) information for the investor advisorytypeexperience an array of strings that contains the investor's advisory type experience clientclassification a string that contains the client classification for the investor moneyorigin an array of strings that contains the investor's source of money pep a boolean value that indicates whether or not the investor is a politically exposed person sanctions a boolean value that indicates whether or not the investor is subject to sanctions name the name of the investor organizationnumber company unique identifier phone the investor's phone number ssn the investor's social security number type a string that contains the type of investor zipcode the investor's zip code knowledgeandexperienceadvisornotes a string that contains notes written by an advisor within knowledge and experience page proposaladvisornotes a string that contains notes written by an advisor within proposal page purposeandrisk an object that contains information about the client's investment purpose and risk, including their expectation of risk, experience, and risk strategy advisornotes notes added by advisor when filling purpose and risk section dropinpercent the client's expectation of the drop in percent of their investment dropinstd the client's expectation of the drop in standard deviation of their investment educationwork the client's education and work experience related to investing expectationofrisk the client's expectation of the level of risk for their investment experience the client's investing experience riskstrategy the client's risk strategy for their investment suitability this object contains information about investors choices regarding suitability inside there can be up to five objects, each object will have same keys names of the categories that tenant checks suitability for values for those keys are answers of the investor how comfortable he is with a given topic within that category example "suitability" { "custom1" { "aif" 4, "equity" 3, "fixedincome" 3, "fundandetfs" 1, "realestate" 4, "unitlink" 2 }, } signed a boolean value that indicates whether or not the investment advice has been signed by the client this field is patched by tenants to indicate that this advice session has been finished and order has been signed by him more about session api docid\ kk3rlqw8kqxu1x ovb4of status a string that contains the current status of the investment advisory meeting sustainability an object that contains information about the client's sustainability preferences alignmentcriteria an object that contains the client's alignment criteria preferences alignmentcriteria1 the client's preference for alignment criteria 1 alignmentcriteria2 the client's preference for alignment criteria 2 preferencecriteria an array of strings that contain the client's preference criteria advisornote a string that contains any notes or comments made by the advisor during the meeting this field defines sustainability section note placeholder type a string that contains the type of investment advice provided updatedat a string that contains the date and time when the investment advisory meeting was last updated sessions get this endpoint is used to retrieve sessions generated within a tenant when calling this endpoint it is possible to filter sessions detailed payload field definitions are listed above success returns session object supplied with number of sessions returned, number of the page, page numbers, how many items per page and whether there are previous or next available pages more about object here session api docid\ kk3rlqw8kqxu1x ovb4of errors here are the reasons why call results in error 401 code { "message" "something went wrong signature expired please log in again signature has expired " } authorization token is incorrect generate new token session get this endpoint is used to retrieve one session based on advice id additionally it allows to enable / disable investor data and investor goals detailed payload field definitions are listed above success returns session object more about object here session api docid\ kk3rlqw8kqxu1x ovb4of errors here are the reasons why call results in error 401 code { "message" "something went wrong signature expired please log in again signature has expired " } authorization token is incorrect generate new token 404 code { "detail" {}, "message" "advice was not found" } it means that advice id is incorrect session patch this endpoint is used to patch one session based on advice id it allows to patch session values executed and signed detailed payload field definitions are listed above patch payload example { "executed" true, "signed" "waiting"//"waiting";"signed";"declined" } success returns session object more about object here session api docid\ kk3rlqw8kqxu1x ovb4of errors here are the reasons why call results in error 401 code { "message" "something went wrong signature expired please log in again signature has expired " } authorization token is incorrect generate new token disclaimers session api do not return deleted sessions