API reference

Vendor, volunteer or partner application

Stores an idempotent vendor, volunteer or partner application after module, campaign and required contact checks; submission does not approve it.

POSThttps://api.sparkglim.net/api/white-label/v1/submissions

Access model

Access model: Server-side Organization HMAC
Required scope: submissions:write
Documented availability: Implemented in source

Availability is verified from source, not a live production guarantee.

Private signing stays on your server. API Version 1 uses signature format v2; it is not API v2.

Headers

Name	Type	Validation
`x-white-label-domain`Required Verified website hostname used to resolve the approved organization account and bind this request.	`string`	Validation: verified HTTPS hostname.
`x-white-label-key-id`Required Identifier extracted from the single issued Private Key value; never send its secret in this header.	`string`	Validation: issued private key internal identifier.
`x-white-label-signature-version`Required Selects the domain-bound signing format; API routes remain Version 1.	`string`	Validation: 2.
`x-white-label-timestamp`Required Request signing time in milliseconds, checked against the server clock to reject stale requests.	`string`	Validation: 13 digit milliseconds; within five minutes.
`x-white-label-nonce`Required Fresh random signing value recorded by the server to reject replay of a signed request.	`string`	Validation: fresh 16–128 [A-Za-z0-9_-].
`x-white-label-signature`Required HMAC-SHA256 of the canonical domain, idempotency key, campaign credential, timestamp, nonce, method, path, sorted query and exact body hash.	`string`	Validation: lowercase hexadecimal HMAC-SHA256.
`x-white-label-campaign-key`Optional Optional complete Campaign Key that narrows a private request to the same authorized campaign.	`string`	Validation: complete optional scoped keyId:secret.
`X-Idempotency-Key`Required Stable business-operation identity reused on retries with unchanged request details; different details under the same key are rejected.	`string`	Validation: 16–128 [A-Za-z0-9_-].

Request

Name	Type	Validation
`type`Required Supported resource kind, reaction kind or discovery campaign filter specified by this endpoint.	`enum`	Validation: volunteer \| vendor \| partner.
`campaignId`Required Existing campaign record within the caller’s account and any narrower campaign credential.	`string`	Validation: UUID.
`details`Required Strict applicant-information object; only the documented fields are accepted.	`object`	Validation: strict allowed fields.
`details.fullName`Required Applicant identity or requested operating space recorded with the vendor, volunteer or partner application.	`string`	Validation: 2–120.
`details.email`Required Contact email used by the configured campaign or account workflow; never a credential granting access by itself.	`string`	Validation: email <=254.
`details.phone`Required Member or applicant contact phone used by the existing account workflow.	`string`	Validation: valid phone <=40.
`details.description`Required Organizer-provided description explaining this campaign or ticket type.	`string`	Validation: 10–3000.
`details.businessName`Optional Applicant identity or requested operating space recorded with the vendor, volunteer or partner application.	`string`	Validation: <=160; required for vendor/partner.
`details.category`Optional Configured campaign category or approved settings category, depending on the resource.	`string`	Validation: <=120; required for volunteer.
`details.stand`Optional Applicant identity or requested operating space recorded with the vendor, volunteer or partner application.	`string`	Validation: <=80.
`clientIp`Optional Original client IP supplied by an authorized backend; used by existing abuse controls.	`string`	Validation: valid IP.

Request

Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

POST /api/white-label/v1/submissions

http

POST /api/white-label/v1/submissions HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
X-Idempotency-Key: example_stable_operation_0001
Content-Type: application/json

{
  "type": "volunteer",
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "details": {
    "fullName": "Example applicant",
    "email": "applicant@example.com",
    "phone": "+233200000000",
    "description": "Example application description.",
    "category": "Example configured category"
  }
}

Response

Success response · HTTP 201

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending",
    "created_at": "2030-01-01T00:00:00.000Z"
  },
  "requestId": "wlapi_example"
}

Error response · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Limits & retries

Organization limiter: 120 requests per key and 300 per IP per window; honor Retry-After and X-RateLimit headers.

Source compatibility

Authorized operations require account-specific testing.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/auth.ts
server/src/white-label/schemas.ts
server/src/white-label/organization-service.ts
server/src/white-label/service.ts

Access model

Headers

Request

Request

Response

Limits & retries

Source compatibility

Continue building