---
agentTools:
  projectIndex: https://liberis.readme.io/llms.txt
---

# Cancels the application

If successful, the application is returned to allow partners to verify that the correct application has been cancelled.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Liberis API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.liberis.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://example.com/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/Application/{applicationId}/cancel": {
      "put": {
        "summary": "Cancels the application",
        "description": "",
        "operationId": "cancel-application",
        "parameters": [
          {
            "name": "applicationId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"partnerId\": \"string\",\n  \"reference\": \"string\",\n  \"currency\": \"string\",\n  \"createdDate\": \"2022-09-26T10:16:04.470Z\",\n  \"customerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"applicationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"applicationStatus\": \"string\",\n  \"applicationType\": \"string\",\n  \"acceptsCards\": true,\n  \"amount\": \"string\",\n  \"bankAccountType\": \"string\",\n  \"bankRoutingNumber\": \"string\",\n  \"businessStartDate\": \"2022-09-26T10:16:04.470Z\",\n  \"businessRisk\": \"string\",\n  \"consentApplicationComms\": true,\n  \"consentPartnerDataSharing\": true,\n  \"consentDisclaimer\": true,\n  \"consentFooter\": true,\n  \"consentSameProductComms\": true,\n  \"consentSimilarProductComms\": true,\n  \"consentOtherProductComms\": true,\n  \"consentBureauSearch\": true,\n  \"consentBureauSearchDate\": \"2022-09-26T10:16:04.470Z\",\n  \"consentAuthorisation\": true,\n  \"consentSettlementTime\": true,\n  \"consentAccountCreation\": true,\n  \"email\": \"string\",\n  \"legalName\": \"string\",\n  \"legalEntity\": \"string\",\n  \"marketingCampaign\": \"string\",\n  \"marketingContent\": \"string\",\n  \"marketingMedium\": \"string\",\n  \"marketingSource\": \"string\",\n  \"marketingTerm\": \"string\",\n  \"processApplication\": true,\n  \"companyNumber\": \"string\",\n  \"scorecardDecision\": \"string\",\n  \"registeredCity\": \"string\",\n  \"registeredPostcode\": \"string\",\n  \"registeredState\": \"string\",\n  \"registeredStreet\": \"string\",\n  \"registeredCountry\": \"string\",\n  \"tradingName\": \"string\",\n  \"tradingCity\": \"string\",\n  \"tradingPostcode\": \"string\",\n  \"tradingState\": \"string\",\n  \"tradingStreet\": \"string\",\n  \"tradingCountry\": \"string\",\n  \"selectedPricing\": {\n    \"termLength\": 0,\n    \"purchaseAmount\": 0,\n    \"purchasePrice\": 0,\n    \"contractPurchasePrice\": 0,\n    \"contractPurchaseAmount\": 0,\n    \"factor\": 0,\n    \"split\": 0\n  },\n  \"paymentChannels\": [\n    {\n      \"name\": \"string\",\n      \"reference\": \"string\",\n      \"type\": \"string\",\n      \"primary\": true\n    }\n  ],\n  \"applicants\": [\n    {\n      \"id\": \"string\",\n      \"email\": \"string\",\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"dateOfBirth\": \"2022-09-26\",\n      \"primary\": true,\n      \"ownershipPercentage\": 0,\n      \"mailingCity\": \"string\",\n      \"mailingPostcode\": \"string\",\n      \"mailingState\": \"string\",\n      \"mailingStreet\": \"string\",\n      \"mailingCountry\": \"string\",\n      \"movedInDate\": \"2022-09-26T10:16:04.471Z\",\n      \"homeOwnership\": 1,\n      \"mobile\": \"string\",\n      \"telephone\": \"string\",\n      \"type\": 0,\n      \"removeApplicant\": true,\n      \"socialSecurityNumber\": \"string\"\n    }\n  ],\n  \"clickToSign\": true,\n  \"partnerName\": \"string\",\n  \"legalProcessorName\": \"string\",\n  \"useofFunds\": \"string\",\n  \"sic\": \"string\",\n  \"industry\": \"string\",\n  \"averageMonthlyVolumes\": 0,\n  \"forecastedVolumes\": \"string\",\n  \"expectedProvider\": \"string\",\n  \"paymentProcessorEmail\": \"string\",\n  \"kycDate\": \"2022-09-26T10:16:04.471Z\",\n  \"kycOutcome\": \"string\",\n  \"kycCustomerRiskCategory\": \"string\",\n  \"preapprovalStatus\": \"string\",\n  \"referralAgentName\": \"string\",\n  \"referralAgentEmail\": \"string\",\n  \"taxId\": \"string\",\n  \"monthlyVolumes\": [\n    {\n      \"date\": \"2022-09-26T10:16:04.471Z\",\n      \"amount\": 0\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "partnerId": {
                      "type": "string",
                      "example": "string"
                    },
                    "reference": {
                      "type": "string",
                      "example": "string"
                    },
                    "currency": {
                      "type": "string",
                      "example": "string"
                    },
                    "createdDate": {
                      "type": "string",
                      "example": "2022-09-26T10:16:04.470Z"
                    },
                    "customerId": {
                      "type": "string",
                      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                    },
                    "applicationId": {
                      "type": "string",
                      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                    },
                    "applicationStatus": {
                      "type": "string",
                      "example": "string"
                    },
                    "applicationType": {
                      "type": "string",
                      "example": "string"
                    },
                    "acceptsCards": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "amount": {
                      "type": "string",
                      "example": "string"
                    },
                    "bankAccountType": {
                      "type": "string",
                      "example": "string"
                    },
                    "bankRoutingNumber": {
                      "type": "string",
                      "example": "string"
                    },
                    "businessStartDate": {
                      "type": "string",
                      "example": "2022-09-26T10:16:04.470Z"
                    },
                    "businessRisk": {
                      "type": "string",
                      "example": "string"
                    },
                    "consentApplicationComms": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentPartnerDataSharing": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentDisclaimer": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentFooter": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentSameProductComms": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentSimilarProductComms": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentOtherProductComms": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentBureauSearch": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentBureauSearchDate": {
                      "type": "string",
                      "example": "2022-09-26T10:16:04.470Z"
                    },
                    "consentAuthorisation": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentSettlementTime": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "consentAccountCreation": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "email": {
                      "type": "string",
                      "example": "string"
                    },
                    "legalName": {
                      "type": "string",
                      "example": "string"
                    },
                    "legalEntity": {
                      "type": "string",
                      "example": "string"
                    },
                    "marketingCampaign": {
                      "type": "string",
                      "example": "string"
                    },
                    "marketingContent": {
                      "type": "string",
                      "example": "string"
                    },
                    "marketingMedium": {
                      "type": "string",
                      "example": "string"
                    },
                    "marketingSource": {
                      "type": "string",
                      "example": "string"
                    },
                    "marketingTerm": {
                      "type": "string",
                      "example": "string"
                    },
                    "processApplication": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "companyNumber": {
                      "type": "string",
                      "example": "string"
                    },
                    "scorecardDecision": {
                      "type": "string",
                      "example": "string"
                    },
                    "registeredCity": {
                      "type": "string",
                      "example": "string"
                    },
                    "registeredPostcode": {
                      "type": "string",
                      "example": "string"
                    },
                    "registeredState": {
                      "type": "string",
                      "example": "string"
                    },
                    "registeredStreet": {
                      "type": "string",
                      "example": "string"
                    },
                    "registeredCountry": {
                      "type": "string",
                      "example": "string"
                    },
                    "tradingName": {
                      "type": "string",
                      "example": "string"
                    },
                    "tradingCity": {
                      "type": "string",
                      "example": "string"
                    },
                    "tradingPostcode": {
                      "type": "string",
                      "example": "string"
                    },
                    "tradingState": {
                      "type": "string",
                      "example": "string"
                    },
                    "tradingStreet": {
                      "type": "string",
                      "example": "string"
                    },
                    "tradingCountry": {
                      "type": "string",
                      "example": "string"
                    },
                    "selectedPricing": {
                      "type": "object",
                      "properties": {
                        "termLength": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "purchaseAmount": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "purchasePrice": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "contractPurchasePrice": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "contractPurchaseAmount": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "factor": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "split": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        }
                      }
                    },
                    "paymentChannels": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "string"
                          },
                          "reference": {
                            "type": "string",
                            "example": "string"
                          },
                          "type": {
                            "type": "string",
                            "example": "string"
                          },
                          "primary": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          }
                        }
                      }
                    },
                    "applicants": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "string"
                          },
                          "email": {
                            "type": "string",
                            "example": "string"
                          },
                          "firstName": {
                            "type": "string",
                            "example": "string"
                          },
                          "lastName": {
                            "type": "string",
                            "example": "string"
                          },
                          "dateOfBirth": {
                            "type": "string",
                            "example": "2022-09-26"
                          },
                          "primary": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "ownershipPercentage": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "mailingCity": {
                            "type": "string",
                            "example": "string"
                          },
                          "mailingPostcode": {
                            "type": "string",
                            "example": "string"
                          },
                          "mailingState": {
                            "type": "string",
                            "example": "string"
                          },
                          "mailingStreet": {
                            "type": "string",
                            "example": "string"
                          },
                          "mailingCountry": {
                            "type": "string",
                            "example": "string"
                          },
                          "movedInDate": {
                            "type": "string",
                            "example": "2022-09-26T10:16:04.471Z"
                          },
                          "homeOwnership": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "mobile": {
                            "type": "string",
                            "example": "string"
                          },
                          "telephone": {
                            "type": "string",
                            "example": "string"
                          },
                          "type": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "removeApplicant": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "socialSecurityNumber": {
                            "type": "string",
                            "example": "string"
                          }
                        }
                      }
                    },
                    "clickToSign": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "partnerName": {
                      "type": "string",
                      "example": "string"
                    },
                    "legalProcessorName": {
                      "type": "string",
                      "example": "string"
                    },
                    "useofFunds": {
                      "type": "string",
                      "example": "string"
                    },
                    "sic": {
                      "type": "string",
                      "example": "string"
                    },
                    "industry": {
                      "type": "string",
                      "example": "string"
                    },
                    "averageMonthlyVolumes": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "forecastedVolumes": {
                      "type": "string",
                      "example": "string"
                    },
                    "expectedProvider": {
                      "type": "string",
                      "example": "string"
                    },
                    "paymentProcessorEmail": {
                      "type": "string",
                      "example": "string"
                    },
                    "kycDate": {
                      "type": "string",
                      "example": "2022-09-26T10:16:04.471Z"
                    },
                    "kycOutcome": {
                      "type": "string",
                      "example": "string"
                    },
                    "kycCustomerRiskCategory": {
                      "type": "string",
                      "example": "string"
                    },
                    "preapprovalStatus": {
                      "type": "string",
                      "example": "string"
                    },
                    "referralAgentName": {
                      "type": "string",
                      "example": "string"
                    },
                    "referralAgentEmail": {
                      "type": "string",
                      "example": "string"
                    },
                    "taxId": {
                      "type": "string",
                      "example": "string"
                    },
                    "monthlyVolumes": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "date": {
                            "type": "string",
                            "example": "2022-09-26T10:16:04.471Z"
                          },
                          "amount": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"type\": \"string\",\n  \"title\": \"string\",\n  \"status\": 0,\n  \"detail\": \"string\",\n  \"instance\": \"string\",\n  \"extensions\": {\n    \"additionalProp1\": {},\n    \"additionalProp2\": {},\n    \"additionalProp3\": {}\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "example": "string"
                    },
                    "title": {
                      "type": "string",
                      "example": "string"
                    },
                    "status": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "detail": {
                      "type": "string",
                      "example": "string"
                    },
                    "instance": {
                      "type": "string",
                      "example": "string"
                    },
                    "extensions": {
                      "type": "object",
                      "properties": {
                        "additionalProp1": {
                          "type": "object",
                          "properties": {}
                        },
                        "additionalProp2": {
                          "type": "object",
                          "properties": {}
                        },
                        "additionalProp3": {
                          "type": "object",
                          "properties": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"type\": \"string\",\n  \"title\": \"string\",\n  \"status\": 0,\n  \"detail\": \"string\",\n  \"instance\": \"string\",\n  \"extensions\": {\n    \"additionalProp1\": {},\n    \"additionalProp2\": {},\n    \"additionalProp3\": {}\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "example": "string"
                    },
                    "title": {
                      "type": "string",
                      "example": "string"
                    },
                    "status": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "detail": {
                      "type": "string",
                      "example": "string"
                    },
                    "instance": {
                      "type": "string",
                      "example": "string"
                    },
                    "extensions": {
                      "type": "object",
                      "properties": {
                        "additionalProp1": {
                          "type": "object",
                          "properties": {}
                        },
                        "additionalProp2": {
                          "type": "object",
                          "properties": {}
                        },
                        "additionalProp3": {
                          "type": "object",
                          "properties": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6324a30b9e9fb507b75fcd06:63307ece1f3146003a802114"
}
```