POST/v1/definitions/{key}/rows/{rowId}/underwriting/evaluate

Evaluate a deal against the published rules

Run the workspace's published rule set against this deal and record the answer: a verdict (pass, fail or review), one result per rule with the reason and the figure behind it, and the whole namespace as it was. A verdict of review also opens one row in the manual-review queue. 404 when no published set applies to this deal.

Access class: def:read.

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.

keypath · stringrequired

rowIdpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "at": "string",
    "dealRowId": "",
    "evaluatedByAccountId": "",
    "facts": "string",
    "id": 1,
    "maxScore": 1,
    "results": [
      {
        "condition": "string",
        "observed": "string",
        "outcome": "string",
        "reason": "string",
        "result": "string",
        "ruleKey": "string",
        "ruleName": "string",
        "sortOrder": "string",
        "weight": "string"
      }
    ],
    "review": {
      "assigneeAccountId": "",
      "assigneeRole": "string",
      "createdAt": "string",
      "decidedAt": "string",
      "decidedByAccountId": "",
      "decision": "string",
      "id": 1,
      "instructions": "string",
      "note": "string",
      "runId": 1,
      "stepRowId": 1,
      "subjectId": 1,
      "subjectKind": "string",
      "title": "string",
      "updatedAt": "string",
      "workflowId": 1,
      "workflowKey": "string",
      "workflowName": "string"
    },
    "score": 1,
    "setId": 1,
    "setKey": "string",
    "setName": "string",
    "setVersion": 1,
    "triggerKind": "string",
    "verdict": "string",
    "versionId": 1
  }
}

dataoptional

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

curl --request POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/definitions/string/rows/{rowId}/underwriting/evaluate' \ --header 'Content-Type: application/json' \ --data '{ "body": {}, "params": { ":key": "string", ":rowId": "" }, "query": {}}'

{ "data": { "at": "string", "dealRowId": "", "evaluatedByAccountId": "", "facts": "string", "id": 1, "maxScore": 1, "results": [ { "condition": "string", "observed": "string", "outcome": "string", "reason": "string", "result": "string", "ruleKey": "string", "ruleName": "string", "sortOrder": "string", "weight": "string" } ], "review": { "assigneeAccountId": "", "assigneeRole": "string", "createdAt": "string", "decidedAt": "string", "decidedByAccountId": "", "decision": "string", "id": 1, "instructions": "string", "note": "string", "runId": 1, "stepRowId": 1, "subjectId": 1, "subjectKind": "string", "title": "string", "updatedAt": "string", "workflowId": 1, "workflowKey": "string", "workflowName": "string" }, "score": 1, "setId": 1, "setKey": "string", "setName": "string", "setVersion": 1, "triggerKind": "string", "verdict": "string", "versionId": 1 }}