Skip to main content

Retrieve agreement session status

GET 

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

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.

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.

Returns the current status of an agreement session using its reference ID.

Request

Responses

Agreement session data retrieved

Was this page helpful?