Skip to content

The Job Object

The job object represents the current state of an asynchronous MidLyr job. It is returned by the Get Job endpoint.

{
"id": "job_01HY3K4M7QR9VP2N8WYJF5GTB",
"type": "screen_analysis",
"status": "succeeded",
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:12Z",
"result": {
"type": "analysis.screen.result",
"riskScore": 75,
"findings": []
},
"error": null
}
FieldTypeDescription
idstringStable job id returned by an async submit endpoint.
typestringJob type discriminator. v1 defines screen_analysis and risk_assessment.
statusstringOne of running, succeeded, or failed.
createdAtstringISO 8601 UTC timestamp of when the job was submitted.
updatedAtstringISO 8601 UTC timestamp of the last status transition.
resultobject or nullPresent only when status is succeeded. Shape depends on type — see Result Shapes by Job Type below.
errorobject or nullPresent only when status is failed. Shape: { code, message }.
typeresult shape
screen_analysisScreen Analysis Result Object
risk_assessmentRisk Assessment Result Object
ValueMeaning
runningWork is still in progress. result and error are both null.
succeededWork completed successfully. result is populated.
failedWork reached a terminal failure. error is populated.