BVbvnk
Onboarding

Fetch agreements

Fetch all required agreement documents needed to onboard a Customer.

:::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. :::

get/api/v1/agreement

Request

Query parameters

productstring required
Example:embedded

Type of product, currently only embedded.

countrystring
Example:DE

ISO country code for the correct agreeements

Response

Successful operation

declinableboolean

Indicates whether the agreement can be declined.

descriptionstring

Description of the agreement.

idinteger

Unique identifier for the agreement.

namestring

Name of the agreement.

privacyPolicyDescriptionstring

Description of the privacy policy associated with the agreement.

privacyPolicyNamestring

Name of the privacy policy.

privacyPolicyUrlstring uri

URL to the privacy policy document.

referencestring

Reference identifier for the agreement.

urlstring uri

URL to the agreement document.

Example response

[
  {
    "description": "The BVNK Master Client Agreement governs the opening, use and closure of a BVNK account. Please review the information provided and click to accept.",
    "id": 8,
    "name": "MASTER_CLIENT_AGREEMENT",
    "privacyPolicyDescription": "Privacy Policy describes our data handling practices when you access content we own or operate on the website located at www.bvnk.com or any other associated websites we own or operate",
    "privacyPolicyName": "BVNK Privacy Policy",
    "privacyPolicyUrl": "https://help.bvnk.com/hc/en-us/articles/7662076884882-Privacy-Policy",
    "reference": "9fc28f1a-f946-11ed-a643-027612b7f6b5",
    "url": "https://agreements.bvnk.com/Client_Master_Agreement.pdf"
  }
]

Changes

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