Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.risklegion.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /api/v1/bras

​
Description

Retrieves a paginated list of Business Risk Assessments. Results are filtered based on user role and entity assignments.

​
Query Parameters

ParameterTypeRequiredDescription
statusstringNoFilter by status: draft, in_progress, under_review, approved, cancelled
legal_entity_idUUIDNoFilter by Legal Entity
business_unit_idUUIDNoFilter by Business Unit
pageintegerNoPage number (default: 1)
page_sizeintegerNoItems per page (default: 25, max: 100)

​
Response

{
  "data": [
    {
      "id": "bra-uuid-001",
      "name": "Q1 2026 Retail Banking Assessment",
      "description": "Comprehensive risk assessment for retail operations",
      "legal_entity_id": "le-uuid-001",
      "business_unit_id": "bu-uuid-001",
      "status": "in_progress",
      "period": "Q1 2026",
      "assessor": "John Smith",
      "start_date": "2026-01-01",
      "completion_date": null,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T14:45:00Z",
      "legal_entity": {
        "id": "le-uuid-001",
        "name": "ACME Bank Brasil S.A."
      },
      "business_unit": {
        "id": "bu-uuid-001",
        "name": "Retail Banking"
      }
    }
  ],
  "message": "BRAs retrieved successfully",
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total": 15,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

​
Example Request

curl -X GET "https://api.risklegion.com/api/v1/bras?status=in_progress&page=1&page_size=10" \
  -H "Authorization: Bearer $TOKEN"

​
Role-Based Filtering

RoleData Returned
Client AdminAll BRAs in enterprise
AssessorBRAs for assigned entities
ReviewerBRAs for assigned entities