Sign in
partner-api

Generate a questioner link

Generate a questioner link on the partner's subdomain. Validates requested coverages against partner's allowed_coverages.

post/api/partner/generate-link

Request body

lead_idstring nullable

ID of the lead to attach the link to. Takes priority over contact_email.

contact_emailstring nullable

Resolve the lead by email instead of lead_id. Used only when lead_id is omitted.

coveragesstring[] required

Coverage keys to include. Must be a subset of the coverages your partner account is allowed to offer.

expires_in_daysinteger nullable

Days until the link expires. Omit or set null for no expiry.

Example request

{
  "coverages": [
    "credit-insurance"
  ],
  "lead_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Response

Successful Response

successboolean

Example response

{
  "success": true,
  "data": {
    "application_id": "a1b2c3d4-0000-1111-2222-333344445555",
    "token": "abc123xyz",
    "public_url": "https://apply.riskcube.com/q/abc123xyz",
    "expires_at": "2026-07-12T00:00:00Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.