---
title: "Submit or update your rating for a document"
method: PUT
path: "/documents/{id}/rating"
tags: ["Documents"]
---

# Submit or update your rating for a document

`PUT /documents/{id}/rating`

## Request

- Base URL: `https://api.bankstatemently.com/v1`
- URL: `https://api.bankstatemently.com/v1/documents/{id}/rating`
- Auth: API key in header `X-API-Key`

Submits (or updates) the caller's own 1-5 rating for a completed document. Re-rating overwrites your stored rating and keeps any feedback already stored for it. Requires the caller's own document to be in `completed` status. Rate limit: 10 requests per minute.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `rating` integer, required: 1-5 star rating for this conversion.

## Response `200`

Rating stored.

- object
  - `data` object
    - `rating` integer

## Other responses

- `400`: Invalid rating parameters.
- `401`: Authentication failed, API key revoked, or API key expired.
- `409`: The caller's own document is not found or not yet `completed`.
- `429`: Too many requests. Wait the number of seconds indicated by the `Retry-After` header.
- `500`: An unexpected server error occurred.

---

[API](https://skmtc.dev/bankstatemently/apis/bankstatemently-api.md) · [All operations](https://skmtc.dev/bankstatemently/apis/bankstatemently-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bankstatemently/apis/bankstatemently-api/revisions/4c3b7fb26edf?raw)