---
updatedAt: 2026-10-28T11:18:45.000Z
agentTools:
  projectIndex: https://documentation.lemonway.com/llms.txt
---

# Resume an Onboarding Session

Retrieves a continuation (resume) URL for a previously-started, in-progress onboarding session.

This allows an end-user to return to their onboarding process after leaving the session without completing it.

Important:

The onboardingId must be taken from the response returned by the onboarding creation endpoint (POST /onboardings/company, /association, /sole_trader, /individual).

This ID is mandatory and must be included in the request path

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/onboardings/{onboardingId}/resume": {
      "get": {
        "operationId": "OnboardingsController_createUrl",
        "parameters": [
          {
            "name": "onboardingId",
            "required": true,
            "in": "path",
            "description": "Unique ID of the onboarding process",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateUrlResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "tags": [
          "onboardings"
        ],
        "description": "Retrieves a continuation (resume) URL for a previously-started, in-progress onboarding session.\n\nThis allows an end-user to return to their onboarding process after leaving the session without completing it.\n\nImportant:\n\nThe onboardingId must be taken from the response returned by the onboarding creation endpoint (POST /onboardings/company, /association, /sole_trader, /individual).\n\nThis ID is mandatory and must be included in the request path",
        "summary": "Resume an Onboarding Session"
      }
    }
  },
  "info": {
    "title": "Account & Onboarding Management API",
    "description": "API Account and Onboarding",
    "version": "1.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://onboarding-api.lemonway.com/",
      "description": "Lemonway API",
      "variables": {
        "env": {
          "default": "sandbox",
          "description": "Environment name (sandbox, uat, staging, prod)"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "CreateUrlResponse": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          }
        },
        "required": [
          "url"
        ]
      }
    }
  }
}
```