GET/v1/workspace/readiness

Read what the workspace still needs set up

The paperwork between this workspace and the Lenders surface, answered PER CALLER: the workspace's KYC status, the workspace's signature on the current MSA, and whether THIS person has accepted it. A KYC that is submitted but not yet verified already counts as unlocked; in_progress and rejected do not. Any seat.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "kycStatus": "string",
    "lendersUnlocked": true,
    "msaSigned": true,
    "msaVersion": "string",
    "unlocked": true,
    "workspace": {
      "agreement": {
        "signedByWorkspace": true,
        "version": "string"
      },
      "kycFields": {
        "authorized_signer_email": "string",
        "authorized_signer_name": "string",
        "authorized_signer_title": "string",
        "dba": "string",
        "entity_type": "string",
        "legal_name": "string",
        "notice_address": "string",
        "notice_email": "string",
        "tax_id_last4": "string"
      },
      "kycMissingFields": [
        "string"
      ],
      "kycStatus": "string"
    },
    "you": {
      "msaSigned": true,
      "msaVersion": "string",
      "needsKyc": true
    }
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

{ "data": { "kycStatus": "string", "lendersUnlocked": true, "msaSigned": true, "msaVersion": "string", "unlocked": true, "workspace": { "agreement": { "signedByWorkspace": true, "version": "string" }, "kycFields": { "authorized_signer_email": "string", "authorized_signer_name": "string", "authorized_signer_title": "string", "dba": "string", "entity_type": "string", "legal_name": "string", "notice_address": "string", "notice_email": "string", "tax_id_last4": "string" }, "kycMissingFields": [ "string" ], "kycStatus": "string" }, "you": { "msaSigned": true, "msaVersion": "string", "needsKyc": true } }}