ZatcaRegulationService_InitiateOnboarding

Staging

https://stg-gateway.invora.app

POST

/api/v1/regulations/zatca/onboarding

Transitional. Prefer RegulationEnrollmentService.BeginEnrollment with
regulation_id="zatca" and an explicit branch_id for new callers.

Start the ZATCA onboarding process using the OTP from the ZATCA portal.
Returns a stream of step-by-step progress events.
The stream completes when all steps finish (or first fatal error).
Clients that want to fire-and-forget can close the stream early
and poll via GetOnboardingProgress.

Request

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/v1/regulations/zatca/onboarding' \
--header 'Content-Type: application/json' \
--data '{
    "otp": "string",
    "environment": "ZATCA_ENVIRONMENT_UNSPECIFIED"
}'

Response Example

200 - Example 1

{
    "step": "ZATCA_ONBOARDING_STEP_UNSPECIFIED",
    "disposition": "ZATCA_DISPOSITION_UNSPECIFIED",
    "requestId": "string",
    "message": "string",
    "errors": [
        {
            "code": "string",
            "category": "string",
            "message": "string"
        }
    ],
    "warnings": [
        {
            "code": "string",
            "message": "string"
        }
    ],
    "isFinal": true
}

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

ZatcaRegulationService_GetIntegrationStatus

ZatcaRegulationService_GetOnboardingProgress