> For the complete documentation index, see [llms.txt](https://dev.ropo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ropo.com/api-reference/control.md).

# Control

Company monitoring

## GET /control/incontrol/{govid}

> Search companies in control

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"Control":{"title":"Control","description":"Control","properties":{"controlId":{"type":"integer"},"govId":{"type":"string"},"startTime":{"type":"string"},"controlName":{"type":"string"},"statusCode":{"type":"string"},"statusText":{"type":"string"}},"type":"object"},"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/incontrol/{govid}":{"get":{"tags":["control"],"summary":"Search companies in control","operationId":"ControlSearchAction","parameters":[{"name":"govid","in":"path","description":"Business Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Control"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```

## POST /control/incontrol/{govid}

> Add company to control

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"ControlAddResponse":{"title":"ControlAddResponse","description":"ControlAddResponse","properties":{"controlId":{"type":"integer"},"govId":{"type":"string"},"startTime":{"type":"string"},"controlName":{"type":"string"},"statusCode":{"type":"string"},"statusText":{"type":"string"}},"type":"object"},"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/incontrol/{govid}":{"post":{"tags":["control"],"summary":"Add company to control","operationId":"ControlAddAction","parameters":[{"name":"govid","in":"path","description":"Business Id","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlAddResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```

## DELETE /control/incontrol/{govid}

> Delete company from control

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/incontrol/{govid}":{"delete":{"tags":["control"],"summary":"Delete company from control","operationId":"ControlDeleteAction","parameters":[{"name":"govid","in":"path","description":"Business id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Control disabled"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```

## GET /control/reportsbygovid/{govid}

> Search reports by businessid

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"ControlReport":{"title":"ControlReport","description":"ControlReport","properties":{"reportId":{"type":"integer"},"controlId":{"type":"integer"},"govId":{"type":"string"},"controlName":{"type":"string"},"datetime":{"type":"string"}},"type":"object"},"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/reportsbygovid/{govid}":{"get":{"tags":["control"],"summary":"Search reports by businessid","operationId":"ControlReportsbygovidAction","parameters":[{"name":"govid","in":"path","description":"Business Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ControlReport"}}}}},"400":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"404":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```

## GET /control/reportsbydate/{date}

> Search reports by date

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"ControlReport":{"title":"ControlReport","description":"ControlReport","properties":{"reportId":{"type":"integer"},"controlId":{"type":"integer"},"govId":{"type":"string"},"controlName":{"type":"string"},"datetime":{"type":"string"}},"type":"object"},"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/reportsbydate/{date}":{"get":{"tags":["control"],"summary":"Search reports by date","operationId":"ControlReportsByDateAction","parameters":[{"name":"date","in":"path","description":"Report date","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ControlReport"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```

## GET /control/reports/{reportid}

> Get report

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"ControlReportResponse":{"title":"ControlReportResponse","description":"ControlReportResponse","properties":{"reportId":{"type":"integer"},"controlId":{"type":"integer"},"timestamp":{"type":"string"},"control_govid":{"type":"string"},"control_name":{"type":"string"},"control_rating":{"type":"string"},"control_paydex":{"type":"string"},"control_ratingdate":{"type":"string"},"control_scoringchange":{"type":"string"},"control_ratingchange":{"type":"string"},"control_namechange":{"type":"string"},"control_newpaymentfault":{"type":"string"},"control_newaccountingdetails":{"type":"string"},"control_companydel":{"type":"string"},"control_fusion":{"type":"string"},"control_epr":{"type":"string"},"control_prevrating":{"type":"string"},"control_duns":{"type":"string"},"control_receivinggovid":{"type":"string"},"control_score":{"type":"string"},"control_payment_code1":{"type":"string"},"control_payment_date1":{"type":"string"},"control_payment_amount1":{"type":"integer"},"control_payment_ref1":{"type":"string"},"control_payment_receiver1":{"type":"string"},"control_payment_code2":{"type":"string"},"control_payment_date2":{"type":"string"},"control_payment_amount2":{"type":"integer"},"control_payment_ref2":{"type":"string"},"control_payment_receiver2":{"type":"string"},"control_payment_code3":{"type":"string"},"control_payment_date3":{"type":"string"},"control_payment_amount3":{"type":"integer"},"control_payment_ref3":{"type":"string"},"control_payment_receiver3":{"type":"string"},"control_payment_code4":{"type":"string"},"control_payment_date4":{"type":"string"},"control_payment_amount4":{"type":"integer"},"control_payment_ref4":{"type":"string"},"control_payment_receiver4":{"type":"string"},"control_payment_code5":{"type":"string"},"control_payment_date5":{"type":"string"},"control_payment_amount5":{"type":"integer"},"control_payment_ref5":{"type":"string"},"control_payment_receiver5":{"type":"string"},"control_payment_code6":{"type":"string"},"control_payment_date6":{"type":"string"},"control_payment_amount6":{"type":"integer"},"control_payment_ref6":{"type":"string"},"control_payment_receiver6":{"type":"string"},"control_payment_code7":{"type":"string"},"control_payment_date7":{"type":"string"},"control_payment_amount7":{"type":"integer"},"control_payment_ref7":{"type":"string"},"control_payment_receiver7":{"type":"string"},"control_payment_code8":{"type":"string"},"control_payment_date8":{"type":"string"},"control_payment_amount8":{"type":"integer"},"control_payment_ref8":{"type":"string"},"control_payment_receiver8":{"type":"string"},"control_payment_code9":{"type":"string"},"control_payment_date9":{"type":"string"},"control_payment_amount9":{"type":"integer"},"control_payment_ref9":{"type":"string"},"control_payment_receiver9":{"type":"string"}},"type":"object"},"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/reports/{reportid}":{"get":{"tags":["control"],"summary":"Get report","operationId":"ControlReportAction","parameters":[{"name":"reportid","in":"path","description":"Id of report","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successfull operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlReportResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```

## GET /control/reportspdf/{reportid}

> Get report in PDF-format

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"control","description":"Company monitoring"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"ControlPdfDataResponse":{"title":"ControlPdfDataResponse","description":"ControlPdfDataResponse","properties":{"data":{"type":"string","format":"byte"}},"type":"object"},"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}},"paths":{"/control/reportspdf/{reportid}":{"get":{"tags":["control"],"summary":"Get report in PDF-format","operationId":"ControlReportPdfAction","parameters":[{"name":"reportid","in":"path","description":"Id of report","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Control report PDF encoded in base64","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPdfDataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlError"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://dev.ropo.com/api-reference/control.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.