RegulationEnrollmentService_BeginEnrollment

Staging

https://stg-gateway.invora.app

POST

/api/v2/regulations/{regulationId}/enrollment/branches/{branchId}/begin

Begin a fresh enrollment for the given branch. Restarts the plugin state
machine from NotStarted; existing in-progress state for the (branch,
regulation) pair is overwritten. Streams one EnrollmentStep per state
transition. The final step has is_final=true and disposition=Issued on
success or Rejected/Error on failure.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://stg-gateway.invora.app/api/v2/regulations//enrollment/branches//begin' \
--header 'Content-Type: application/json' \
--data '{
    "regulationId": "string",
    "branchId": "string",
    "config": {}
}'

Response Example

200 - Example 1

{
    "step": {
        "stepName": "string",
        "disposition": "ENROLLMENT_DISPOSITION_UNSPECIFIED",
        "message": "string",
        "isFinal": true,
        "errors": [
            "string"
        ],
        "warnings": [
            "string"
        ],
        "requestId": "string",
        "metadata": {
            "property1": "string",
            "property2": "string"
        }
    }
}

Modified at 2026-06-11 18:59:10

RegulationInfoService_RetrySubmission

RegulationEnrollmentService_ResumeEnrollment