> ## Documentation Index > Fetch the complete documentation index at: https://docs.proconvey.co.uk/llms.txt > Use this file to discover all available pages before exploring further. # Create a new case > Creates a new case with the specified type, branch, fee earner, and property details. ## OpenAPI ````yaml https://v2.proconvey.co.uk/api/v2/doc post /api/v2/cases openapi: 3.1.0 info: title: ProConvey Public API version: '2.0' description: Public API for case management. servers: [] security: [] tags: - name: Cases description: Case management operations including creation, retrieval, and data access - name: Clients description: Client records for the organisation - name: Webhooks description: >- Webhooks available for receiving updates of events on the ProConvey platform - name: Organisations description: Organization management and setup - name: System description: System and utility endpoints including branches and documentation paths: /api/v2/cases: post: tags: - Cases summary: Create a new case description: >- Creates a new case with the specified type, branch, fee earner, and property details. requestBody: required: true content: application/json: schema: type: object required: - type - reference - branchId - feeEarnerId - propertyPrice - line_1 - postcode - clients properties: type: type: string enum: - Sale - Remortgage - Purchase - Transfer description: The type of case branchId: type: string description: ID of the branch handling the case feeEarnerId: type: string description: ID of the fee earner assigned to the case propertyPrice: type: number description: Price of the property in GBP reference: type: string description: Case reference conveyancingFee: type: number minimum: 0 description: >- Conveyancing fee in GBP (optional; omit or set to 0 if not applicable) introducerId: type: integer description: >- ID of the introducer to associate with this case. Use GET /api/v2/introducers to retrieve valid IDs. isNewBuild: type: boolean description: Whether the property is a new build (default false) isLeasehold: type: boolean description: Whether the property is leasehold (default false) isBuildingSafetyAct: type: boolean description: >- Whether the property is subject to the Building Safety Act (BSA) (default false) paymentOnAccount: type: number description: Payment on account amount paymentOnAccountRequired: type: boolean description: Whether payment on account is required line_1: type: string description: Address line 1 line_2: type: string description: Address line 2 line_3: type: string description: Address line 3 post_town: type: string description: Post town county: type: string description: County postcode: type: string description: Postcode uprn: type: string description: Unique Property Reference Number (optional) ta6_6th: type: boolean description: TA6 (6th) form required (Sale cases only) ta7_5th: type: boolean description: TA7 (5th) form required (Sale cases only) ta9: type: boolean description: TA9 form required (Sale cases only) ta10: type: boolean description: TA10 form required (Sale cases only) clients: type: array minItems: 1 description: Array of clients to attach to the new case (existing or new) items: type: object description: >- Client object - can be either an existing client (by ID) or a new client (with details). All optional properties below apply to both existing and new clients. allOf: - oneOf: - title: Existing client type: object required: - clientId properties: clientId: type: string format: uuid description: >- ID of an existing client. Only clientId may be provided — name and email are read from the stored client record and cannot be overridden here. - title: New client type: object required: - firstName - lastName - emailAddress properties: title: type: - string - 'null' description: Client's title (e.g., Mr, Mrs, Ms, Dr) firstName: type: string description: First name of the new client lastName: type: string description: Last name of the new client emailAddress: type: string format: email description: Email address of the new client companyName: type: - string - 'null' description: Company name (if applicable) telephoneNumber: type: - string - 'null' description: >- Phone number in E.164 format (required when checkProvider is thirdfort or title-guardian) - type: object description: >- Optional properties that can be set for both existing and new clients properties: smsInvite: type: - boolean - 'null' description: Whether to send SMS invitations idAndAmlCheck: type: - boolean - 'null' description: Whether an ID and AML check task is required onboardingLetters: type: - boolean - 'null' description: Whether to send onboarding letters instructionLetters: type: - boolean - 'null' description: >- Whether to send instruction letters for estate-agent cases verificationOfFunds: type: - boolean - 'null' description: Whether source of funds is required statements: type: - boolean - 'null' description: Whether statements are required questionnaire: type: - boolean - 'null' description: Whether questionnaire is required sofType: type: - string - 'null' enum: - purchaser - giftor description: Source of funds type idCheckType: type: - string - 'null' enum: - standard - original description: Type of ID check required checkProvider: type: - string - 'null' enum: - yoti - thirdfort - title-guardian - armalytix description: Provider for ID checks armalytixIdCheckType: type: - string - 'null' enum: - NFC - NON_NFC - NFC_POO - GIFTORS_ID_CHECK description: >- Armalytix ID check template (required when checkProvider is armalytix). NFC = HM Land Registry Digital ID Standard, NON_NFC = devices without NFC, NFC_POO = NFC plus proof of ownership, GIFTORS_ID_CHECK = NFC-first check for giftors with option to switch to Non-NFC. ongoing: type: - boolean - 'null' description: Whether ongoing monitoring is required international: type: - boolean - 'null' description: Whether this is an international client poa: type: - boolean - 'null' description: Whether Proof of Address is required poo: type: - boolean - 'null' description: Whether Proof of Ownership is required sofProvider: type: - string - 'null' enum: - upload - thirdfort - armalytix description: Provider for source of funds verification armalytixCheckType: type: - string - 'null' enum: - RESIDENTIAL_PROPERTY_PURCHASE - COMPANY_PROPERTY_PURCHASE - STANDARD - GIFTOR - SOF_REFRESH description: >- Armalytix check type (required when sofProvider is armalytix) armalytixAmountToProve: type: - string - 'null' description: >- Amount to prove in GBP (required when sofProvider is armalytix, except for SOF_REFRESH) armalytixBankDataRange: type: - string - 'null' enum: - 6_MONTHS - 9_MONTHS - 1_YEAR - 1_YEAR_3_MONTHS - 1_YEAR_6_MONTHS - 1_YEAR_9_MONTHS - 2_YEARS description: >- Bank data range (required when sofProvider is armalytix) armalytixBusinessName: type: - string - 'null' description: >- Business name (required for COMPANY_PROPERTY_PURCHASE check type) armalytixMatterDescription: type: - string - 'null' description: >- For GIFTOR checks, the name of the person who received the gift. For other types, the property address (auto-derived from case address if omitted). interestedPartyType: type: - string - 'null' description: Type of interested party isGiftorOnly: type: - boolean - 'null' description: Whether the client is a giftor only customLetterContent: type: - string - 'null' description: Custom onboarding letter content responses: '201': description: Case created successfully content: application/json: schema: type: object properties: id: type: string description: The ID of the created case '400': description: Bad request - invalid JSON or missing required fields content: application/json: schema: type: object properties: message: type: string description: Error message ````