BVbvnk
Onboarding

Retrieve application status

Changed on

Retrieves the current onboarding application state, including associates' validation status, outstanding required documents, questionnaire definitions, validation errors, and agreement statuses.

  • Associate validationStatus=INVALID means outstanding requirements still exist; inspect requiredDocuments, questionnaireDefinitions, and validationErrors.
  • On rejection, rejectLabels and clientComment describe why resubmission is required.
get/onboarding/v1/applications/{onboardingId}/status

Request

Path parameters

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

Onboarding application ID returned by the create onboarding request.

Response

Current onboarding status and requirements

onboardingIdstring uuid required
status'NOT_STARTED' | 'IN_PROGRESS' | 'SUBMITTED' | 'REQUIRED_ACTIONS' | 'APPROVED' | 'REJECTED' | 'SUSPENDED' required

Application status.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "onboardingId": "810fd34b-54d3-4a95-9d87-28804c3353b9",
  "status": "SUBMITTED",
  "createdAt": "2026-03-25T10:57:35.056865Z",
  "updatedAt": "2026-03-25T10:57:38.991647Z",
  "associates": [
    {
      "id": "07b099fa-e1ee-4ad4-9cc4-6f2513a5a240",
      "roles": [
        "ACCOUNT_REPRESENTATIVE",
        "DIRECTOR",
        "SIGNATORY",
        "UBO"
      ],
      "percentageOfOwnership": 100,
      "validationStatus": "INVALID",
      "requiredDocuments": [
        {
          "docSetType": "SELFIE",
          "types": [
            "SELFIE"
          ],
          "status": "REJECTED",
          "rejectLabels": [
            "BAD_SELFIE"
          ],
          "clientComment": "A new liveness check has been requested."
        }
      ],
      "questionnaireDefinitions": [],
      "validationErrors": [
        {
          "message": "identificationDocuments must not be empty"
        }
      ]
    }
  ],
  "agreements": [
    {
      "id": "9adf3e01-8d13-4fc3-9fc4-8f3f6fd0af44",
      "name": "Partner Platform Agreement (Non-US)",
      "status": "PENDING",
      "declinable": false
    }
  ]
}

Changes