This endpoint is used to cancel a pending application, regardless of its current status (e.g., DRAFT, SUBMITTED, APPROVED, or DECLINED). Canceling an application removes it from the onboarding workflow and marks it as CANCELED in the system.

• Request
• Response
• Payload examples

Request

Endpoint

Required keys

Body

This API does not require body parameters.

Response

Field Definitions

❗️

Note

After receiving a successful response, update the application status in your CRM or internal system to CANCELED.

Payload Examples

Request

cURL Request Example

curl --request POST \
     --url https://api-sandbox.flexfactor.com/v1/application/{application_id}/cancel \
     --header 'Authorization: bearer {the token returned by /oauth2}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'

Response

HTTP Example for a Successful Cancellation

HTTP/1.1 200 OK
Content-Type: application/json

{}

Example for Handling Errors

If the provided application ID is invalid or the bearer token is unauthorized, the API will return an appropriate error status and message.

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "errors": [
    "Invalid application ID."
  ]
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "errors": [
    "Authentication failed. Invalid bearer token."
  ]
}

❕

Notes

• Ensure the {id} parameter corresponds to a valid application.
• The API returns an empty body on success; any errors will be provided in the response.
• Use this endpoint to cancel applications in bulk automation workflows or as part of an internal cancellation process.