DocumentationAPI Reference
ApiAPI ReferenceDocuments

Get document metadata

Returns metadata for a single document owned by the authenticated account. Requires the documents:read scope.

GET
/documents/{documentId}

Returns metadata for a single document owned by the authenticated account. 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

Document metadata.

application/json
  1. response
success*boolean
data*
error*
Example Request
curl -X GET 'https://outriskai.com/api/public/v1/documents/string'
Example Response
{  "success": true,  "data": {    "document": {      "id": "string",      "title": "string",      "status": "pending",      "uploaded_at": "2019-08-24T14:15:22Z",      "description": "string",      "promisor": "string",      "promisee": "string",      "value": 0,      "document_type": "string"    }  },  "error": {}}

Upload or register a document for analysis POST

Registers a contract for analysis. Provide either a public HTTPS URL or a multipart file upload. The document is copied into OutRiskAI storage at submission time and analysis is queued in the background, so the response returns immediately. Requires the documents:write scope.

Delete a document DELETE

Permanently removes a document owned by the authenticated account, together with its analysis results. Requires the documents:write scope.