The home menu view is the main ussd view and the start point for end users to interact with pipevest system.

Accessing the Home View

Make a GET request to /home
  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/home?customerId=123456
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "X-Client-Id" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \

Example Response

{
  "data": {
    "ussdMessage": "Select an investment option:\n 1. Stocks\n 2. My Portfolio\n 3. Back",
    "ussdOptions": [
      {
        "option": 1,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/stocks?customerId=123456",
        "requestType": "GET"
      },
      {
        "option": 2,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/portfolio?customerId=123456",
        "requestType": "GET"
      }
    ]
  },
  "code": 200,
  "message": "Success"
}

Query parameters

queryDefinitionRequired
customerIdThe unique customer identiferYes

Home View Example

USSD Home View

Check out an example of the ussd home view

The home menu view is the main ussd view and the start point for end users to interact with pipevest system.

Accessing the Home View

Make a GET request to /home
  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/home?customerId=123456
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "X-Client-Id" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \

Example Response

{
  "data": {
    "ussdMessage": "Select an investment option:\n 1. Stocks\n 2. My Portfolio\n 3. Back",
    "ussdOptions": [
      {
        "option": 1,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/stocks?customerId=123456",
        "requestType": "GET"
      },
      {
        "option": 2,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/portfolio?customerId=123456",
        "requestType": "GET"
      }
    ]
  },
  "code": 200,
  "message": "Success"
}

Query parameters

queryDefinitionRequired
customerIdThe unique customer identiferYes

Home View Example

USSD Home View

Check out an example of the ussd home view