HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
POST

Issuer Launchpad

Retain folder setup intent

/api/v2/launchpad/offerings/{offering_id}/folder-setup
AUTHENTICATIONBearer token · launchpad:writeAUTHORITATIVE OWNERlaunchpad-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Retain one immutable folder setup intent per listing and expected binding revision. Rebuild workspace authority; do not create, bind, share or publish storage objects.

WHEN THIS CALL IS USEFUL

Use before a new recoverable listing folder operation, after selecting the actual dedicated workspace.

OUTCOME · Create or advance

What changes

Retains private workflow intent, command receipt and audit/outbox event; creates no folder, ACL, encryption material, publication or workspace.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to advance retain folder setup intent.
  • Connects private issuer preparation to public, citation-bearing disclosure without exposing draft evidence or collapsing review, signature, finality, and availability into one state.

ISOLATION + AUTHORITY

Workspace, issuer, offering, security-class draft, Data Vault object version, requirement pack, diligence case, evidence view, reviewer decision, auditor attestation, release, signer, validator finality, replication, public index, and investor eligibility remain distinct. Launchpad cannot issue, mint, custody, sell, trade, match, settle, or authorize an investment, and its public routes expose only finalized disclosure evidence.

BEFORE YOU CALL

  • Authenticate at the documented boundary: bearer+scope.
  • Supply the required offering_id (path), folder_name (body), expected_binding_version (body) exactly as defined by the live contract.
  • Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
  • Resolve the authenticated workspace and derived issuer, reviewer, auditor, signer, or publisher authority for this stage; use exact Data Vault versions and distinguish private preparation from finalized public disclosure.

WHAT TO DO NEXT

  • Re-read retain folder setup intent using the canonical identifier returned by this operation.
  • Reconcile an ambiguous response with the same idempotency key before attempting another mutation.
  • Follow returned canonical identifiers and commitments into the next explicit Launchpad stage, re-attesting protected evidence and re-reading release finality before public reliance.

AGENT GUIDANCE

  • Use retain folder setup intent only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Supply the required offering_id (path), folder_name (body), expected_binding_version (body) exactly as defined by the live contract.
  • Keep draft creation, evidence linking, evidence-view pinning, review, attestation, release assembly, freeze, signature, submission, validator finality, replicated availability, indexing, and supersession as separate lifecycle facts.
  • After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE
AuthorizationheaderRequired

Bearer tokenCredential containing launchpad:write authority.EXAMPLEBearer hc_live_…

offering_idpathRequired

identifierStable offering id selecting the exact resource addressed by this route.EXAMPLEoffering-id-01

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated stable key reused for retries of the same logical mutation.

existing_folder_idbodyOptional

identifier · 32 | nullExplicit selected root-folder UUID, or omit/null to retain a creation intent. The actual owner rechecks root location and access.EXAMPLEexisting-folder-id-01

expected_binding_versionbodyRequired

integer · >=0Zero for first setup, otherwise the current binding revision for explicit existing-folder replacement.Schema range: 0 to 9223372036854776000EXAMPLE0

folder_namebodyRequired

string · 1–128Exact nonblank folder name, with no control characters. A name never identifies an existing folder for recovery.Length: 1 to 128 charactersEXAMPLEExample listing

REQUEST

JSON body example

{
  "existing_folder_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "expected_binding_version": 0,
  "folder_name": "example-folder-name"
}

RESPONSES

Status and payload examples

200Original immutable intent recovered, or null on read when absent. Not a storage success receipt.Mutation completed · JSON RESPONSE+
{
  "created_at": "2026-09-02T18:30:00Z",
  "existing_folder_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "expected_binding_version": 0,
  "folder_name": "example-folder-name",
  "offering_id": "123e4567-e89b-12d3-a456-426614174000",
  "setup_id": "123e4567-e89b-12d3-a456-426614174000",
  "subject_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "vault_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "version": 1,
  "workspace_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB"
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then re-read retain folder setup intent using the canonical identifier returned by this operation.
RETRY SAFETY
Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION
Persist returned identifiers, versions, commitments, and receipts. Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
201Immutable private setup intent retained; no folder has been created or bound.Mutation completed · JSON RESPONSE+
{
  "created_at": "2026-09-02T18:30:00Z",
  "existing_folder_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "expected_binding_version": 0,
  "folder_name": "example-folder-name",
  "offering_id": "123e4567-e89b-12d3-a456-426614174000",
  "setup_id": "123e4567-e89b-12d3-a456-426614174000",
  "subject_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "vault_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "version": 1,
  "workspace_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB"
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then re-read retain folder setup intent using the canonical identifier returned by this operation.
RETRY SAFETY
Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION
Persist returned identifiers, versions, commitments, and receipts. Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
400Malformed path, typed intent, headers or idempotency key.Request must change · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY
Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION
Compare the submitted values with the documented constraints before another call. Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
401Bearer credential is missing or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY
Retry only with a newly valid credential and fresh replay-protection values. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION
Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
403Current launchpad:write or vault:read scope is missing.Authority or policy denied · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY
Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION
Confirm the caller and resource resolve to the same authority boundary for issuer-private offerings, evidence, reviews, disclosures, readiness milestones, publication, and finality receipts.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
404The listing or selected accessible folder was not found.Resource not visible · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY
Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION
Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
409Intent, initiator, listing or binding revision conflicts with retained state.State reconciliation required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY
Retry only after reconciling the conflict. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION
Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
422Current workspace, Vault, root-folder access or owner policy rejects the operation.Request must change · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY
Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION
Compare the submitted values with the documented constraints before another call. Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
502The owner returned an incomplete or mismatched intent receipt.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY
Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION
Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.
503Identity, Data Vault or Launchpad is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY
Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION
Refresh the offering revision, evidence commitments, review and disclosure status, readiness milestone, issuer authority, and publication or finality receipt.
ESCALATE WHEN
Escalate when issuer authority, diligence evidence, disclosures, approvals, publication, or chain finality cannot be matched to one immutable revision.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • Retain one immutable folder setup intent per listing and expected binding revision. Rebuild workspace authority; do not create, bind, share or publish storage objects.
  • The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
  • Mutations are retry-safe only when the same Idempotency-Key and canonical request body are reused.
  • The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
  • Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.
DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗