Update Competency (Document) | ComplyFlow Help Center

POST [ staff/{people_custom1}/upload-document ]

Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/upload-document  
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/upload-document

Overview

This endpoint adds a competency (requirement) to a staff user in the current Organisation in the ComplyFlow system.

{people_custom1} can be renamed to any parameter for the account that makes sense, e.g. Internal Staff ID

Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user will required the permissions below:

API User
User is Staff
Users have View and Edit Staff Permission
The user has the same Organisation as the selected Staff

Please also refer to the Permissions Overview guide.

Query parameters

FIELD	TYPE	DESCRIPTION	Example	REQUIRED	DEFAULT	PATTERN
`people_custom1`	`string`	Custom ID used to get staff detail data	`staff1`	YES		`[a-zA-Z0-9]`

The Custom ID needs to be configured on each Staff User’s profile - the ID needs to be unique

Body properties/Payload

FIELD	TYPE	DESCRIPTION	REQUIRED
`id_document_category`	`integer`	Document Category ID	Yes
`valid_from`	`date`	Date of document valid from (DD-MM-YYYY)	No
`valid_to`	`date`	Date of document valid to (DD-MM-YYYY)	No

Request Example

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/staff/shughi/upload-document' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]' \
--form 'id_document_category="777"'

Response Example

The API Request returns the status of this API action.

{
    "token": "",
    "data": {
        "success": true
    }
}

Response Information

Status	Response
`success`	`status` = `true`
`error`	`status` = `false` `error` = 1 of the following people_custom1 not found = "Staff not found" id_document_category not found = "Document category not found" `error_code` (in the same order as the error message above) 4 5