BVbvnk
Customers

Create agreement signing session

Changed on

Creates a session for customers to agree to the conditions and requirements.

:::warning Before calling this endpoint, make sure you are not onboarding customers from restricted jurisdictions. For more information, see BVNK Acceptable Use Policy. :::

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

post/platform/v1/customers/agreement/sessions

Request

Request body

customerType'COMPANY' | 'INDIVIDUAL' required

Type of customer

countryCodestring required

Country code of the customer's address in the ISO 3166-1 alpha-2 format.

useCase'STABLECOIN_PAYOUTS' | 'EMBEDDED_STABLECOIN_WALLETS' | 'EMBEDDED_FIAT_ACCOUNTS' | 'CARD_AGREEMENT' required

Type of product to which the customer agreement applies.

customerReferencestring

Unique reference of the customer for whom the agreement session is being created.

Example request

{
  "customerType": "COMPANY",
  "countryCode": "DE",
  "useCase": "EMBEDDED_FIAT_ACCOUNTS",
  "customerReference": "b4e5c3d1-9a42-4e7b-8f34-7c6b2a89f3df"
}

Response

Agreement session created successfully

referencestring

Unique session identifier.

status'PENDING' | 'SIGNED' | 'DECLINED'

Session status.

  • PENDING: The session is pending and the agreements have not been signed yet.
  • SIGNED: The agreement has been signed by the customer.
  • DECLINED: The customer has declined the agreement.
customerTypestring

Type of customer.

  • INDIVIDUAL: A natural person.
  • COMPANY: A legal entity.
useCasestring

Type of product to which the customer agreement applies.

  • STABLECOIN_PAYOUTS: Enables sending stablecoin payments to customers' crypto wallets from fiat or crypto balances.
  • EMBEDDED_STABLECOIN_WALLETS: Allows partners to create and manage stablecoin wallets for their customers to facilitate crypto transactions.
  • EMBEDDED_FIAT_ACCOUNTS: Enables creating virtual accounts with unique vIBANs for customers to send, hold, and receive fiat funds.
  • CARD_AGREEMENT: Enables issuing virtual cards linked to customer wallets.
countryCodestring

Country code of the customer's address in the ISO 3166-1 alpha-2 format.

expiresOnstring date-time

Session expiration (ISO8601 timestamp)

Example response

{
  "reference": "5f74fee5-3e8e-4dcc-85cd-24b9205bb44d",
  "status": "PENDING",
  "customerType": "INDIVIDUAL",
  "useCase": "EMBEDDED_FIAT_ACCOUNTS",
  "countryCode": "DE",
  "expiresOn": "2025-05-23T15:05:20.859141Z",
  "agreements": [
    {
      "name": "main_agreement",
      "displayName": "Main Agreement",
      "description": "Terms and conditions for using AKME LTD. services.",
      "url": "https://example.com/docs/agreement.pdf",
      "status": "PENDING",
      "privacyPolicyName": "Privacy Policy",
      "privacyPolicyDescription": "Details how your data is used.",
      "privacyPolicyUrl": "https://example.com/privacy"
    }
  ]
}

Changes

  • c386d436bf2cRevision changes
    • info

      added the new optional request property

    • info

      added the new CARD_AGREEMENT enum value to the request property