DocumentationAPI Reference
ApiAPI ReferenceDocuments

Risk analysis results

Returns the generated summary, identified risks and suggested solutions. Available once the processing status is completed. Requires the documents:read scope.

GET
/documents/{documentId}/analysis

Returns the generated summary, identified risks and suggested solutions. Available once the processing status is completed. Requires the documents:read scope.

Authorization

bearerAuth
headerAuthorizationBearer <API Key>

An OutRiskAI API key, sent as a bearer token. Create keys in the dashboard under Settings; the secret is shown only once.

Path Parameters

documentId*string

Document identifier returned when the document is submitted.

Response Body

Analysis results for the document.

application/json
  1. response
success*boolean
data*
error*
Example Request
curl -X GET 'https://outriskai.com/api/public/v1/documents/string/analysis'
Example Response
{  "success": true,  "data": {    "analysis": {      "document_id": "string",      "summary": "string",      "risks": [        {          "id": "string",          "risk": {            "text": "string",            "title": "string",            "example": "string",            "description": "string"          },          "solutions": [            {              "id": "string",              "solution": "string"            }          ],          "created_at": "2019-08-24T14:15:22Z"        }      ],      "risk_count": 0    }  },  "error": {}}

Processing status GET

Reports background analysis progress. Poll this endpoint until the status is completed or failed, then read the analysis. Requires the documents:read scope.

Database Schema

Comprehensive Prisma relational schema reference for users, contract documents, risks, solutions, and API credentials.