Skip to content
On this page

Approve Application

Accepts requests for approving an application.

Endpoints

EnvironmentAPI Endpoint
Sandboxhttps://onprem-test.streamline.laboremus.ug/api/onboarding/approval

Request

Request Type : POST

Authorization

INFO

Always add your Subscription key to the request.

Query Parameters

NameTypeRequiredDescription
vstringyesThe version of the API

Content type

multipart/form-data

Request Body

NameTypeDescription
applicationIdstring (uuid)A unique identifier for the application associated with the action.
actionstringThe action being performed on the application (e.g., Make, Update).
commentstringA comment or note regarding the action taken on the application.

Example Request Body

json
{
  "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "action": "Make",
  "comment": "string"
}
{
  "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "action": "Make",
  "comment": "string"
}

Response

Content type

application/json

Response Body

NameTypeDescription
statusbooleanIndicates the success or failure of the operation (e.g., true for success, false for failure).
messagestringA message providing additional information about the operation's result.

Example Response Body

json
{
  "status": true,
  "message": "string"
}
{
  "status": true,
  "message": "string"
}

Error Response

400 Bad Request

application/json

NameTypeDescription
typestring or nullType of error response
titlestring or nullThe title of the error response
statusinteger(int32)The status of the error response
traceIdstring or nullThe traceId of the error request producing the error
errorsobjectObject defining the errors

errors

NameTypeDescription
propertyArray of stringsThe definition of the errors

401 Unauthorized

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

403 Forbidden

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

404 Not Found

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

500 Server Error

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

Tech served right