BVbvnk
Onboarding

Retrieve assigned agreements

Changed on

Returns agreements assigned to an onboarding application. All assigned agreements must reach ACCEPTED status for onboarding to proceed.

Use this endpoint with the onboarding application ID: GET /onboarding/v1/assigned-agreements?applicationId={onboardingId}.

Assigned agreements can be accepted at any point after customer creation (before or after document uploads); there is no ordering dependency.

get/onboarding/v1/assigned-agreements

Request

Query parameters

applicationIdstring uuid required
Example:810fd34b-54d3-4a95-9d87-28804c3353b9

Onboarding application ID returned by POST /onboarding/v1/applications.

Response

Assigned agreements for the onboarding application

idstring uuid required
applicationIdstring uuid required
status'PENDING' | 'ACCEPTED' | 'DECLINED' required
createdAtstring date-time required

Example response

[
  {
    "id": "06d119bc-64f6-46b2-aea2-3ff94c4c616f",
    "applicationId": "810fd34b-54d3-4a95-9d87-28804c3353b9",
    "agreement": {
      "id": "c83a528b-8c7a-4d95-9fbb-3fbe14332f7b",
      "name": "Partner Platform Agreement (Non-US)",
      "description": "Terms and conditions for Partner Platform customers outside the US",
      "urn": "urn:agreement:epc-partner-platform-non-us",
      "agreementType": "EXTERNAL_LINK",
      "externalUrl": "https://help.bvnk.com/hc/en-us/sections/example",
      "declinable": false
    },
    "status": "PENDING",
    "createdAt": "2026-03-25T10:57:38.145505Z"
  }
]

Changes