Customers
Retrieve 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. :::
Returns the current status of an agreement session using its reference ID.
get/platform/v1/customers/agreement/sessions/{reference}
Request
- Base URLhttps://api.sandbox.bvnk.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
referencestring required
The unique identifier of the agreement session to retrieve.
Response
Agreement session data retrieved
Changes
No recorded changes to this operation across all 3 revisions of this API.