Signing Customer Agreements

🚧

Early Access

Please note that this endpoint is currently in early access, and it may undergo changes as we continue to improve and refine the functionality.

This section describes the BVNK Agreements flow, enabling your customers (Embedded Partner Customers) to review and accept required agreements seamlessly. There are two available methods:

1. Signing via HostedURL (redirect)

Create a Hosted Agreement Session

• Call POST /customers/agreement/sessions to generate a unique signing session.
• BVNK responds with a hostedUrl for agreement signing.

Redirect User to BVNK’s Agreement Page

• Redirect your customer to the provided hostedUrl, appending the redirectUri parameter.
• The user views all necessary agreements and can Submit or Cancel.

Sign Agreements

• Clicking Submit sets the session status to SIGNED, completing the signature process.

Completion and Return Redirect

• The user is redirected (302) back to your provided redirectUri.
• The redirect includes the session status (SIGNED or DECLINED).

Create Embedded Customer

• If the status is SIGNED, use the signedAgreementSessionReference in a POST /customers call to create the new Embedded Customer.

2. Signing via APIs (No Redirect)

BVNK now supports a direct API approach for signing agreements, removing the need for a user redirect.

Create Agreement Session via API

Request Body

Example Request

{
  "countryCode": "DE",
  "customerType": "Individual",
  "useCase": "FIAT"
}

Response Body

Each agreement includes:

• name: Agreement identifier.
• displayName: Public-facing title.
• description: Agreement details.
• url: URL for agreement document.
• privacyPolicyName: Privacy policy title.
• privacyPolicyDescription: Privacy policy details.
• privacyPolicyUrl: URL to privacy policy.

Example Response

{
  "reference": "5f74fee5-3e8e-4dcc-85cd-24b9205bb44d",
  "status": "PENDING",
  "customerType": "Individual",
  "useCase": "FIAT",
  "countryCode": "DE",
  "expiresOn": "2025-05-23T15:05:20.859141Z",
  "agreements": [ ... ]
}

Update Agreement Session Status

• Call PUT /customers/agreement/sessions/{reference} with the session reference obtained in the previous step.
• Payload to include session status (SIGNED or DECLINED).

{
  "status": "SIGNED"
}

• This updates the session status accordingly.

Verify Session Status

• Retrieve session status by calling GET /customers/agreement/sessions/{reference} with the session reference.
• Response confirms current session status (SIGNED, PENDING, or DECLINED).

Example Verified Response

{
  "reference": "5f74fee5-3e8e-4dcc-85cd-24b9205bb44d",
  "status": "SIGNED",
  ...
}

Creating a Customer

Once you've verified that the session status is SIGNED, proceed to create your customer (business or individual):

• Include the verified reference obtained from the signed agreement session as the signedAgreementSessionReference field in your POST /customers request payload.
• This ensures the agreements are properly linked and recognized in your new customer creation.

Example

{  
  "signedAgreementSessionReference": "5f74fee5-3e8e-4dcc-85cd-24b9205bb44d",  
  "type": "INDIVIDUAL",   
  ...  
}

Ensure this reference matches exactly the signed agreement session you've validated to successfully finalize the onboarding process.

Key Considerations

• Store session references securely.
• Inform users clearly about the legally binding nature of agreements.
• Monitor and manage session expirations carefully.