Plans

The plans resource is used for getting and modifying plan related information including questionnaire response from customer, plan report and recommendation.


POST/plans

Create a plan

This endpoint creates a new plan.

Required attributes

  • Name
    customerId
    Type
    string
    Description

    Id of the customer

  • Name
    subscriptionPlanCode
    Type
    string
    Description

    code for the eligible subscription plan. Valid codes are ‘core’

Request

POST
/plans
curl https://beta-api.uprise.us/plans \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -D '{"customerId": "81aa278c-a0f7-4767-b9be-d63977ba2bca", "subscriptionPlanCode": "core"}'

Response

{
  "id": "04e429ba-6f6c-4765-8289-a4794495f9f3"
}

GET/plans/:planId/questionnaire

List of questionnaire

This endpoint gives the questionnaire object of a given plan.

Required attributes

  • Name
    planId
    Type
    string
    Description

    An unique id of a financial plan

Request

GET
/plans/:planId/questionnaire
curl https://beta-api.uprise.us/plans/f5e856b6-ecb5-42dd-89d2-a21422435b3d/questionnaire \
  -H "Authorization: Bearer {token}"

Response

{
  "How confident do you feel in managing your finances?": 5,
  "Which are most important to you?": "",
  "What type of degree did you earn?": ["Graduate"],
  "Does your current job offer any of the following?": ["StockOption"],
  "Upload a screenshot of your stock options": "",
  "What health insurance do you have?": ["Parent's plan"],
  "Please upload your company’s benefits guide": "",
  "What benefits does your company offer?": "",
  "Do you have any additional income?": "",
  "What is your credit score?": ["670-739"],
  "Roughly how much do you spend every month?": "",
  "Anything else before we wrap up?": ""
}

POST/plans/:planId/response

Submit questionnaire response

This endpoint submit the questionnaire response.

Required attributes

  • Name
    planId
    Type
    string
    Description

    An unique id of a financial plan.

  • Name
    response
    Type
    json
    Description

    customer’s questionnaire response in JSON format.

Request

POST
/plans/:planId/response
curl  https://beta-api.uprise.us/plans/5bbed68d-853b-4171-b3c5-42f514c6a29c/response \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"response": {"How confident do you feel in managing your finances?": "7"}}'

Response

{
  "id": "04e429ba-6f6c-4765-8289-a4794495f9f3"
}

PATCH/plans/:planId/response

Update questionnaire response

This endpoint updates the questionnaire response.

Required attributes

  • Name
    planId
    Type
    string
    Description

    An unique id of a financial plan.

  • Name
    response
    Type
    json
    Description

    customer’s questionnaire response in JSON format.

Request

PATCH
/plans/:planId/response
curl  https://beta-api.uprise.us/plans/5bbed68d-853b-4171-b3c5-42f514c6a29c/response \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"response": {"How confident do you feel in managing your finances?": "7"}}'

Response

{
  "id": "04e429ba-6f6c-4765-8289-a4794495f9f3"
}

PUT/plans/:planId/response

Update questionnaire response (DEPRECATED)

This endpoint updates the questionnaire response.

Required attributes

  • Name
    planId
    Type
    string
    Description

    An unique id of a financial plan.

  • Name
    response
    Type
    json
    Description

    customer’s questionnaire response in JSON format.

Request

PUT
/plans/:planId/response
curl  https://beta-api.uprise.us/plans/5bbed68d-853b-4171-b3c5-42f514c6a29c/response \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"response": {"How confident do you feel in managing your finances?": "7"}}'

Response

{
  "id": "04e429ba-6f6c-4765-8289-a4794495f9f3"
}

GETplans/:planId/report

Plan report

This endpoint provides a detailed view of the financial plan report.

Required attributes

  • Name
    planId
    Type
    string
    Description

    An unique id of a financial plan.

Request

GET
plans/:planId/report
curl  https://beta-api.uprise.us/plans/5c59c810-3aaf-4995-b736-bd324aef45af/report \
  -H "Authorization: Bearer {token}" \
  -d '{"planId": "5c59c810-3aaf-4995-b736-bd324aef45af"}'

Response

{
  "id": "5c59c810-3aaf-4995-b736-bd324aef45af",
  "planSummary": "It’s great to meet you - my name is Caroline, I’m the Lead Financial Advisor at Ocho.\r\n\r\nLooking through your info, your finances are in excellent shape: you have built up your business, are ahead on accumulating wealth, and have clear financial goals in mind. \r\n\r\nFor your initial plan I'll focus on a few topics to prioritize: getting health insurance coverage, retirement contributions, managing taxes, and investing towards goals.\r\n\r\nOur top priority is that the plan makes sense and is right for you, so we can adjust and cover new topics over time!\r\n\r\nWith Ocho Professional you can message me anytime – whether you have questions about this plan or as things come up throughout the year.\r\nCaroline",
  "currentAssesment": {
      "summary": "In short, you’re doing **good!** \r\nYou’ve got most things covered, but we’ve identified a few areas to focus on, highlighted in _blue_. Don’t worry, we’ll tell you what to do!",
      "detail": "[{\"isCoveredByCustomer\":false,\"itemName\":\"Credit\",\"itemDesc\":\"#CREDIT_RATING is considered really good!\",\"itemCategory\":\"foundation\"},{\"isCoveredByCustomer\":true,\"itemName\":\"Debt\",\"itemDesc\":\"You’re paying off highest-interest rate debt ASAP\",\"itemCategory\":\"foundation\"},{\"isCoveredByCustomer\":true,\"itemName\":\"Health Insurance\",\"itemDesc\":\"You need converage for the unexpected\",\"itemCategory\":\"foundation\"},{\"isCoveredByCustomer\":true,\"itemName\":\"Emergency Savings\",\"itemDesc\":\"You have 6 months savings — great job!\",\"itemCategory\":\"money_allocation\"},{\"isCoveredByCustomer\":false,\"itemName\":\"Retirement Savings\",\"itemDesc\":\"Make tax advantaged contributions\",\"itemCategory\":\"money_allocation\"},{\"isCoveredByCustomer\":false,\"itemName\":\"Benefits\",\"itemDesc\":\"You’re taking good advantage of your benefits.\",\"itemCategory\":\"money_allocation\"},{\"isCoveredByCustomer\":true,\"itemName\":\"Savings & Investments\",\"itemDesc\":\"Work towards your goals\",\"itemCategory\":\"money_allocation\"},{\"isCoveredByCustomer\":false,\"itemName\":\"Tax Optimizations\",\"itemDesc\":null,\"itemCategory\":\"other\"},{\"isCoveredByCustomer\":false,\"itemName\":\"Emergency\",\"itemDesc\":null,\"itemCategory\":\"other\"}]"
  },
  "recommendations": [
      {
          "id": "dbffea55-f345-4c96-bc37-edf66093e149",
          "valueAdd": "Build credit without thinking about it.",
          "category": "Credit",
          "tags": [
              "credit"
          ],
          "summary": "Set up autopay on your credit card to make sure the balance is paid in-full and on-time.",
          "context": "The key to credit is to make sure you always pay your balance in full, on time! This becomes more important as you start getting more credit - car payments, credit cards, etc. Paying on time is the biggest component of your credit score. Have patience with this - it takes time to rebuild credit. You will get there with consistency!",
          "actionLink": {
              "label": "Capital One",
              "url": "https://www.capitalone.com/"
          },
          "status": "new",
          "priority": 1,
          "isViewed": false,
          "addlResources": [
              {
                  "resourceType": "link",
                  "resourceObj": {
                      "label": "Raising credit score",
                      "url": "https://www.lendingtree.com/personal/study-raising-credit-score-saves-money/"
                  }
              },
              {
                  "resourceType": "attachment",
                  "resourceObj": {
                      "fileId": "f42ed07e-0c4c-4922-b6e3-ffe681fff3e7",
                      "fileName": "plan_image.png",
                      "fileType": "image/png"
                  }
              }
          ]
      }
  ]
}


GETplans/:planId/rec/:recId

Plan recommendation

This endpoint provides a detailed view of a specific recommendation from the financial plan.

Required attributes

  • Name
    planId
    Type
    string
    Description

    An unique id of a financial plan.

  • Name
    recId
    Type
    string
    Description

    An unique id of a recommendation.

Request

GET
plans/:planId/rec/:recId
curl  https://beta-api.uprise.us/plans/5c59c810-3aaf-4995-b736-bd324aef45af/rec/dbffea55-f345-4c96-bc37-edf66093e149 \
  -H "Authorization: Bearer {token}" \
  -d '{"planId": "5c59c810-3aaf-4995-b736-bd324aef45af" , "recId":"dbffea55-f345-4c96-bc37-edf66093e149"}'

Response

{
  "id": "dbffea55-f345-4c96-bc37-edf66093e149",
  "planId": "5c59c810-3aaf-4995-b736-bd324aef45af",
  "valueAdd": "Build credit without thinking about it.",
  "category": "Credit",
  "tags": [
      "credit"
  ],
  "summary": "Set up autopay on your credit card to make sure the balance is paid in-full and on-time.",
  "context": "The key to credit is to make sure you always pay your balance in full, on time! This becomes more important as you start getting more credit - car payments, credit cards, etc. Paying on time is the biggest component of your credit score. Have patience with this - it takes time to rebuild credit. You will get there with consistency!",
  "actionLink": {
      "label": "Capital One",
      "url": "https://www.capitalone.com/"
  },
  "status": "new",
  "priority": 1,
  "isViewed": false,
  "addlResources": [
      {
          "resourceType": "link",
          "resourceObj": {
              "label": "Raising credit score",
              "url": "https://www.lendingtree.com/personal/study-raising-credit-score-saves-money/"
          }
      },
      {
          "resourceType": "attachment",
          "resourceObj": {
              "fileId": "f42ed07e-0c4c-4922-b6e3-ffe681fff3e7",
              "fileName": "plan_image.png",
              "fileType": "image/png"
          }
      }
  ]
}