Skip to navigation
API ReferenceConsumersStatements

List Statements

Get a list with all PDF Statements generated for a consumer

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

consumer_external_idstringRequired

Query parameters

pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
searchstringOptional
A search term.
statement_typestringOptional

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

Response

This endpoint returns an object.
countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"