consumers

Retrieve Statement

Changed on Sep 29, 2026

Get a pdf in b64encode

get/v2/consumers/{consumer_external_id}/statements/{pdf_filename}/download/

Request

Base URL
https://api.upwardli.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/upwardli/apis/upwardli/docs/v2/consumers/:consumer_external_id/statements/:pdf_filename/download/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

consumer_external_idstring required

pdf_filenamestring required

Query parameters

statement_typestring

Optional. 'credit_builder' or 'card'. Left out or unrecognised, the product is detected from the consumer.

Response

file_namestring

contentstring

content_typestring

Changes

Sep 29, 20269ae55ff0d84c Revision changes
- info
  added the new optional query request parameter statement_type
Sep 17, 2026134ae1fdc51f Revision changes
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security bearerAuth was added to the API

Operation history (3 revisions)