# Platform API overview

> REST endpoints for partners embedding cSquare compliance checks, AML status and risk scoring into their own products.

Source: https://docs.csquaregrc.com/api/overview


The Platform API lets partners embed cSquare GRC inside their own product. You manage **sub-organizations** (your customers), run compliance, AML and risk checks against their programs, and receive alerts and webhooks.

## Base URL

The Platform API is served from your workspace's API endpoint, shown in **Settings > API keys** in the app. Paths below are relative to that base, for example `POST /compliance/check`.

## Endpoints

| Method | Path | Purpose | Credits |
| --- | --- | --- | --- |
| GET | `/health` | Check your key and list endpoints | 0 |
| GET | `/sub-orgs` | List sub-organizations | 0 |
| POST | `/sub-orgs` | Create a sub-organization | 0 |
| POST | `/compliance/check` | Run a compliance check on a program | 5 |
| POST | `/aml/status` | AML compliance status for a program | 5 |
| POST | `/risk/score` | AI risk assessment for a program | 15 |
| GET | `/webhooks` | List webhook subscriptions | 0 |
| POST | `/webhooks` | Subscribe to events | 0 |
| GET | `/alerts` | Regulatory and compliance alerts | 0 |

Credits are charged to the sub-organization you pass as `sub_org_id`, when you pass one.

## Responses

All responses are JSON. Check results carry a confidence envelope so you can tell deterministic rule results from AI analysis. See [Errors](/api/errors) for status codes.

## Next

- [Authenticate](/api/authentication) with an API key.
- Walk through the [endpoint reference](/api/endpoints).