Skip to content
Pipevest Developers

Reports

Planned — on our roadmap. This capability is documented so you can design your integration ahead of time. It is not yet enabled to call; for initial go-live, investment flows transact via USSD. If it is part of your integration plan, contact us. See what’s available today.

A report aggregates data for a given topic. We current support USER, TRANSACTION and REGULATORY reports. This document will guide you on how to create, and get report details.

Creating a Report

Section titled “Creating a Report”

To create a report:

Terminal window
  curl --request POST \
    --url https://api.pipevest.com/v1/reports\
    --header 'Authorization: Bearer 123456' \
    --header 'Content-Digest: sha-512=:RK/0qy18MlBSVnWgjwz6lZEWjP/lF5HF9bvEF8FabDg=:' \
    --header 'Content-Length: 18' \
    --header 'Content-Type: application/json' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("authorization" "content-digest" "content-length" "content-type" "x-client-id" "x-idempotency-key" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \
    --header 'X-Idempotency-Key: 123456' \
    ...
    --data '{"reportTypes": ["REGULATORY", "USER"]}'

URL and emails

Section titled “URL and emails”

You can specify a url and/or email when creating a report request. The resulting report will be sent to the specified url and/or email.

Terminal window
  curl --request POST \
    --url https://api.pipevest.com/v1/reports\
    ...
    --data '{..., "url": "https://companyx/reports", "email": "reports@companyx.com"}'

Retrieving Reports

Section titled “Retrieving Reports”

When requesting report details you can do so either by getting:

  • A list of reports
  • An report by a given Id

List of Reports

Section titled “List of Reports”
Terminal window
  curl --request GET \
    --url https://api.pipevest.com/v1/reports\
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("authorization" "content-digest" "content-length" "content-type" "x-client-id" "x-idempotency-key" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \

Report by Id

Section titled “Report by Id”
Terminal window
  curl --request GET \
    --url https://api.pipevest.com/v1/reports/123456\
    ...

Entity Reference

Section titled “Entity Reference”
Property Definition
reportId Unique report identifier
reportTypes List of report types
status Current status of the report
url A valid url to receive the report
email A valid email to receive the report
createdAt Created at unix timestamp
updatedAt Updated at unix timestamp

Status

Section titled “Status”
Name Definition
PROCESSING Report is currenting processing
COMPLETED Report has completed processing
ERROR Report processing ended in an error

Report Types

Section titled “Report Types”
Name Definition
USER User reports
TRANSACTION Transaction reports
REGULATORY Regulatory reports

Webhook Subscriptions

Section titled “Webhook Subscriptions”
Subscription Definition Domain
REPORT Only events that deal with reports Reports