BVbvnk
Agreements

Get customer agreement

Changed on

Fetch a single customer agreement entry by its UUID. The response includes the agreement's current status (PENDING / ACCEPTED / REJECTED).

get/platform/v2/agreements/{id}

Request

Path parameters

idstring uuid required

Unique identifier of the customer agreement entry.

Response

Customer agreement details

idstring uuid

Unique identifier of the customer agreement entry.

namestring

Human-readable agreement title.

descriptionstring

Short summary of what the agreement covers.

declinableboolean

Whether the customer may reject the agreement. When false, only ACCEPT is valid.

status'PENDING' | 'ACCEPTED' | 'REJECTED'

Current state of the agreement entry.

respondedAtstring date-time

Timestamp at which the customer responded. Absent while status is PENDING.

Changes