Platform — statements endpoints
How to call the platform statement routes. The formal schema is the OpenAPI specification
(openapi/source/platform/parties/parties.yml); this page is the call contract.
Statements are read-only — there is no lifecycle file. All routes require a bearer token
(B2B JWT) with the CLIENT role and an ACTIVE party context. The global /v1 prefix
applies.
Route summary
| Method | Path | Code | Purpose |
|---|---|---|---|
GET | /v1/parties/statements | 200 | List party statements |
GET | /v1/parties/statements/{statementId} | 200 | Download a statement file |
GET /v1/parties/statements — list statements
Query parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | no | 1 | Page of results (standard pagination) |
Response: { statements: Statement[] }. Each item includes statementId, vendorId,
statementType (MONTHLY), issuedAt, and a description.
Returns 500 ACC004005 if the statement type cannot be found.
GET /v1/parties/statements/{statementId} — download a statement
Returns a file stream. The response Content-Type and Content-Disposition headers are
forwarded from the provider's response. The OAS declares application/pdf as the media
type but the actual content type is determined by the provider at runtime and may differ.
statementId must have been obtained from a prior list call.
Errors
| HTTP | Code | When |
|---|---|---|
401 | GEN001002/4/5/6 | Invalid or missing token |
403 | GEN003005/6 | Client or party inactive |
404 | ACC004002 | Statement not found at the provider |
500 | ACC004005 | Statement type (MONTHLY) not found at the provider |
500 | ACC022001 | The provider cannot resolve the statement id |
500 | GEN100001 | Downstream communication failure with the provider |