Skip to content
Controls
/
Updates a control signature's sign-off status

FloQast External API (1.0.0)

Authentication

Requests to FloQast's API must be authenticated using an API key. The API key must be included in the x-api-key header of each request and can be generated in the FloQast application. The key should also have the correct permissions to access the API endpoints you are using. Directions to generate an API key

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://developer.floqast.app/_mock/content/api-reference/openapi/

https://fq-api.floqast.app/

https://fq-api.eu.floqast.app/

https://fq-api.au.floqast.app/

Checklists

Operations

Reconciliations

Operations

Checklist Analytics

Operations

Reconciliation Analytics

Operations

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Users

Operations

Folders

Operations

Controls

Operations

Deletes an inactive control by control mongo ID

Request

Security
x-api-key
Path
idstring(ObjectId)^[a-f\d]{24}$required

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
curl -i -X DELETE \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success - Control deleted

Response
No content

Updates a control signature's sign-off status

Request

Security
x-api-key
Path
idstring(ObjectId)^[a-f\d]{24}$required

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
signatureIdstring(ObjectId)^[a-f\d]{24}$required

The ID of the signature to update

Example: 61d325c84a9f97631731a690
Bodyapplication/json

Request body containing sign-off status

setIsSignedbooleanrequired

Whether to sign (true) or unsign (false) the signature

curl -i -X PATCH \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690/sign/61d325c84a9f97631731a690 \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "setIsSigned": true
  }'

Responses

Success - No Content

Response
No content

Fetches a signed URL for uploading evidence to a control.

Request

The file key returned from this endpoint should be used in the POST /controls/{id}/documents endpoint to associate the uploaded file with the control.

Security
x-api-key
Path
idstring(ObjectId)^[a-f\d]{24}$required

The internal unique identifier for the control

Example: 61d325c84a9f97631731a690
periodstringrequired

The specfic period of the control to attach evidence to

curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/controls/61d325c84a9f97631731a690/upload-url/{period}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataobject(UploadUrl)

Response containing a presigned upload URL and file key for evidence upload.

Response
application/json
{
  "data": {
    "uploadUrl": "https://production-large-payload-store.s3.us-west-2.amazonaws.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890?...",
    "fileKey": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Programs

Operations

Processes

Operations

Guest Users

Operations