---
title: "Update agreement session status"
method: PUT
path: "/platform/v1/customers/agreement/sessions/{reference}"
tags: ["Customers"]
---

# Update agreement session status

`PUT /platform/v1/customers/agreement/sessions/{reference}`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v1/customers/agreement/sessions/{reference}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/agreement/sessions/:reference/put.ts> (a function with typed inputs; its response is checked against the schema)

:::info Customers API v2
The [new customer onboarding flow](../../../get-started/create-embedded-partner-customer/create-customers-com) is recommended for all new integrations.

If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward.
:::

:::warning Use with Customers v1
This endpoint is part of the Agreements v1 flow and must be used together with [Customers v1 endpoints](/bvnk/api-explorer/endpoints/create-customer). Customers created via Customers v2 use a different agreements flow.
:::

Updates the signing status of an agreement session. Typically used after user submission to mark the session as SIGNED or DECLINED.

## Path parameters

- `reference` string, required

## Request body

- object
  - `status` 'SIGNED' | 'DECLINED', required: The new status of the session.
  - `ipAddress` string, ipv4, required: IP address of the user performing the action.

## Response `200`

Agreement session status was successfully updated.

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)