Application API reference.

How it fits together

Three ways to fill a company's application from outside the form, the one journey every path follows, and the rules that hold on all of them. Pick the path that fits what you have; the rest of this page is the API in detail.

Authentication

An owner creates an API key under Company & account › Integrations in the portal. The secret is shown once. Send it as a bearer token on every call; the key acts as the company that created it and can reach only that company's application.

Authorization: Bearer sx_live_…
Content-Type: application/json

Endpoints

A company has one open application at a time. Every call answers with the application and its readiness, the same list the portal's Submit button checks, so you always know what is still open.

Example

Send what you have; leave out what you do not know. The answer tells you what the application still needs, by step and by field key, and where a person finishes it.

curl -X POST https://sourcex.si/api/v1/applications \
  -H "Authorization: Bearer sx_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "Acme CRM",
    "answers": {
      "company": "Cardinal Air & Plumbing",
      "country": "United States",
      "website": "cardinalair.example",
      "status": "Operating",
      "revenue": "$25M–$50M"
    },
    "systems": [
      { "tool_name": "QuickBooks Online", "purpose": "Accounting", "approx_size": "3 GB",
        "data_start": "2015-01", "data_end": "2026-10", "contents": "Invoices and the ledger",
        "exportable": "yes", "export_method": "CSV", "owned_attested": "yes", "records_english": "yes" }
    ],
    "dataset": { "title": "Cardinal operations archive", "categories": ["Operational documentation"] }
  }'

Answer

{
  "id": "6f1c…",
  "company_id": "b2a9…",
  "status": "draft",
  "title": "Cardinal operations archive",
  "updated_at": "2026-11-03T10:12:04.511Z",
  "edit_url": "https://sourcex.si/app/data/6f1c…/edit",
  "readiness": {
    "status": "needs_input",
    "percent": 23,
    "systems": { "listed": 1, "incomplete": 0 },
    "blockers": [
      { "key": "answers-company", "step": "company", "stepLabel": "Company details",
        "label": "11 answers on Company details",
        "message": "Answer every question marked Required on Company details first: What does the company do?; Your name; Work email and 8 more." },
      { "key": "systems", "step": "systems", "stepLabel": "Systems", "label": "At least 3 systems", "message": "…" }
    ],
    "missing": [
      { "field": "whatCompanyDoes", "step": "company", "label": "What does the company do?" },
      { "field": "contactName", "step": "company", "label": "Your name" }
    ]
  }
}

Where each field lands

answers is an object keyed by field. Each key below is one question on the application, on the step and in the section named. A dropdown accepts its options exactly, or plain words that clearly mean one of them (for example "about 30 million" for revenue, "closed in 2023" for status), and is normalised to the option.

Step: Company details (company)

Step: Data overview (headline)

Step: Privacy & restrictions (privacy)

Step: Data profile (files)

Systems

systems is an array, one row per system that holds the records, and fills the table on the Systems step. At least 3 to submit, and each needs a name, what it is used for, what is in it, a start and end month (YYYY-MM), a size, and how it exports. A row whose tool_name matches a system already listed updates that row; the draft's own rows are never removed.

The application's columns, in its order: System / tool · What you use it for · Approx. Export Size (GB/TB) · Years of data · Start Date (YYYY-MM) · End Date (YYYY-MM) · What's in it (examples) · Can it export? · Notes.

Data profile

dataset holds the three answers of the Data profile step that the template does not carry.

Statements

The Review & submit step asks the company to confirm four statements and its authority to apply. Send them only when the person at the company has confirmed them; each is kept as given, and a "no" stops the submission exactly as it does in the portal.

Readiness

readiness on every answer is what the portal's Continue and Submit buttons would still stop on. blockers is that list in step order; missing names the required answers still blank by field key, so you can fill them by key; percent is the application's own progress meter.

Errors

An error answers { "error": "<code>", "message": "…" }; not_ready also carries readiness.

The same over MCP

An AI assistant connected at https://sourcex.si/mcp signs in as you and has the same four steps as tools. It drafts and validates; a person submits. Setup is on Agent integrations.