Trigger vendor onboarding

POST

https://api.light.inc/v1/vendors/{vendorId}/trigger-onboarding

Resends the self-service onboarding magic-link email for a vendor that already has an onboarding form

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Path parameters

vendorId string · uuidrequired

Response

application/json;charset=UTF-8This endpoint returns no content.

cURL

curl -X POST "https://api.light.inc/v1/vendors/3c90c3cc-0d44-4b50-8888-8dd25736052a/trigger-onboarding" \
  -H "Authorization: Basic YOUR_API_KEY"

JavaScript

const res = await fetch("https://api.light.inc/v1/vendors/3c90c3cc-0d44-4b50-8888-8dd25736052a/trigger-onboarding", {
  method: "POST",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

res = requests.post(
    "https://api.light.inc/v1/vendors/3c90c3cc-0d44-4b50-8888-8dd25736052a/trigger-onboarding",
    headers={
        "Authorization": f"Basic {os.environ['LIGHT_API_KEY']}",
    },
)
data = res.json()