API reference

Find the main operations for creating, launching, and tracking your processes, plus guides for integrating the Ormuz API into your applications.

Detailed guides

Some business resources

These pages explain the most common resources. They are not an exhaustive list of public routes: the OpenAPI contract remains the source of truth for all available endpoints, parameters, and responses.

Guide APICompanyCreate, find, and qualify companies.Guide APIContactsManage contacts and their details.Guide APIDossiers d'onboardingOpen and track onboarding cases.Guide APIOrdersCreate and advance orders.Guide APIInvoicesCreate, issue, and track invoices.Guide APILitigesOpen and track dispute cases.Guide APIPaymentsCreate and track business payments.

POST

Execute a process

POST /v1/processes/{id}/runs

Creates a process_instance from an active process definition. Without the option wait, the call immediately returns the created instance with an HTTP status 201.

Request body

inputobjectoptionnel

Input data expected by the definition. Its structure is validated before execution.

merchant_idstring | nulloptionnel

Merchant in which to execute the process when it must be selected explicitly.

start_sourceobjectoptionnel

Trigger-provenance metadata. Ormuz preserves the mode api as the origin of this call.

POST + wait

Wait for a synchronous result

Add wait: { timeout_ms } to wait for the functional result for a bounded duration. If the process completes within this window, the response 200 expose son output. If the timeout is reached, the response 202 preserves the instance identifier to follow later.

This option does not turn the engine into unlimited blocking execution: the maximum accepted timeout is bounded by the platform's public configuration.

GET

Read a process instance

GET /v1/process-instances/{id}

Returns the current state of a process_instance, its definition, status, inputs, optional result, and visible steps. Use this endpoint when your integration must explicitly reread execution state.

For event-driven orchestration, prefer webhooks Ormuzrather than permanent polling.