BVbvnk
Customers

Update agreement session status

:::info Customers API v2 The new customer onboarding flow 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. 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.

put/platform/v1/customers/agreement/sessions/{reference}

Request

Path parameters

referencestring required

The unique identifier of the agreement session to update.

Request body

status'SIGNED' | 'DECLINED' required

The new status of the session.

ipAddressstring ipv4 required

IP address of the user performing the action.

Response

Agreement session status was successfully updated.

Changes

No recorded changes to this operation across all 3 revisions of this API.