Appearance
Approve Application
Accepts requests for approving an application.
Endpoints
| Environment | API Endpoint |
|---|---|
| Sandbox | https://onprem-test.streamline.laboremus.ug/api/onboarding/approval |
Request
Request Type : POST
Authorization
All requests must be authenticated using OAuth 2.0 Client Credentials. Follow the steps in the Authentication section to obtain an access token.
Content type
multipart/form-data
Request Body
| Name | Type | Description |
|---|---|---|
| applicationId | string (uuid) | A unique identifier for the application associated with the action. |
| action | string | The action being performed on the application (e.g., Make, Update). |
| comment | string | A 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
| Name | Type | Description |
|---|---|---|
| status | boolean | Indicates the success or failure of the operation (e.g., true for success, false for failure). |
| message | string | A 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
| Name | Type | Description |
|---|---|---|
| type | string or null | Type of error response |
| title | string or null | The title of the error response |
| status | integer(int32) | The status of the error response |
| traceId | string or null | The traceId of the error request producing the error |
| errors | object | Object defining the errors |
errors
| Name | Type | Description |
|---|---|---|
| property | Array of strings | The definition of the errors |
401 Unauthorized
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
403 Forbidden
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
404 Not Found
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
500 Server Error
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |