--- title: "Finds applications by search parameters (initially one). This API is now deprecated. Please use /applications for appeal validation and /applicationInstruct/setInstruct for appeal submission instead." method: POST path: "/applicationStatus/getBySearchParameters" --- # Finds applications by search parameters (initially one). This API is now deprecated. Please use /applications for appeal validation and /applicationInstruct/setInstruct for appeal submission instead. `POST /applicationStatus/getBySearchParameters` ## Request - Base URL: `http://localhost:8098/ichallenge` - URL: `http://localhost:8098/ichallenge/applicationStatus/getBySearchParameters` - Auth: none declared ## Request body - SearchParameters: Parameters passed in to enable searching for applications. Currently supports only one type/value pair but the interface is designed to support multiple in future. As a side effect this service will send a notification to the Event Publisher to inform them that a request for a possible appeal has been made. - `messageHeader` MessageHeader, required: Message parameters (not business oriented). - `eventDateTime` string, date-time, required: UTC timestamp for debugging purposes - `correlationId` string, required: ID allowing correlation between service consumer and API log files. Expected to be unique, for example, a UUID - `consumer` Consumer, required: Consumer of the service. - `code` 'HMCTS', required: Short code for the consumer - `description` string: Description of the consumer (for legibility reasons) - `searchParams` SearchParametersSearchParamsInner[], required - `spType` 'DOCUMENT_REFERENCE', required: Reference type - `spValue` string, required: Unique reference ## Response `200` OK - SearchResponse: Response containing details of the application search. - `messageHeader` MessageHeader: Message parameters (not business oriented). - `eventDateTime` string, date-time, required: UTC timestamp for debugging purposes - `correlationId` string, required: ID allowing correlation between service consumer and API log files. Expected to be unique, for example, a UUID - `consumer` Consumer, required: Consumer of the service. - `code` 'HMCTS', required: Short code for the consumer - `description` string: Description of the consumer (for legibility reasons) - `messageType` 'RESPONSE_RIGHT_OF_APPEAL_DETAILS': Identifies the type of message - `status` SearchResponseStatusInner[]: An array of persons and application status; generally, the status will be the same for all persons but this format provides flexibility - `person` Person: An individual fufilling a role on the application. - `givenName` string: Person's given names. Assumed to be a concatenated list of names - `familyName` string: Person's family names. Assumed to be a concatenated list of names - `fullName` string: Person's full name - `gender` PersonGender - `code` string: Letter code for the gender - `description` string: Gender description - `dayOfBirth` integer: Day of month the person was born on, from 1-31. No leading zeroes - `monthOfBirth` integer: Month of year (Gregorian calendar) the person was born in, from 1-12. No leading zeroes - `yearOfBirth` integer: Year the person was born in (4 digits) - `nationality` PersonNationality: Person's nationality - `code` string: Short code for the nationality - `description` string: Description of the nationality - `applicationStatus` SearchResponseStatusInnerApplicationStatus: Current status of the individual's application - `documentReference` string: The UAN or Case ID (CID) passed to the Home Office in the original request. (Allows for the UAN/nn value - nn denoting an individual within a group UAN - to be returned to HMCTS, should this value be available.) - `roleType` SearchResponseStatusInnerApplicationStatusRoleType: Role of the individual in this application - `code` string: Code for the role type - `description` string: Description of the role type - `roleSubType` SearchResponseStatusInnerApplicationStatusRoleSubType: Role sub-type of the individual in this application. **Note:** may not be available for legacy CID cases - `code` string: Code for the role sub-type - `description` string: Description of the role sub-type - `applicationType` SearchResponseStatusInnerApplicationStatusApplicationType: Type of application - `code` string: Code for the application type - `description` string: Description of the application type - `claimReasonType` SearchResponseStatusInnerApplicationStatusClaimReasonType: Type of reason for claim on application. **Note:** may not be available for any cases - `code` string: Code for the claim reason type - `description` string: Description of the claim reason type - `decisionType` SearchResponseStatusInnerApplicationStatusDecisionType: Type of decision made on the application - `code` string: Code for the decision type - `description` string: Description of the decision type - `decisionDate` string, date-time: Date (and time, if available) of decision made on the application, in the standard format yyyy-mm-dd (with the HH:mm:ss if the time is available - this won't be displayed if it isn't). All dates/times are assumed to be in UTC - `decisionCommunication` SearchResponseStatusInnerApplicationStatusDecisionCommunication: Communication of the decision - `type` 'EMAIL' | 'POST': Type of communication - `description` string: Description of the communication type - `sentDate` string, date-time: Date (and time, if available) the communication was requested to be sent. This is effectively the decision date. See description of decisionDate for details of how it will be displayed. This is assumed to be in UTC - `dispatchDate` string, date-time: Date (and time, if available) the communication was actually dispatched. See description of decisionDate for details of how it will be displayed. This is assumed to be in UTC - `rejectionReasons` SearchResponseStatusInnerApplicationStatusRejectionReasonsInner[]: Rejection reasons - `reason` string: Reason for application rejection - `metadata` SearchResponseStatusInnerApplicationStatusMetadataInner[]: Additional attributes (metadata) of the application - `code` string, required: Metadata item code - `valueBoolean` boolean: Boolean metadata value - `valueDateTime` string, date-time: Date (and time) metadata value, in the standard format yyyy-mm-dd (with the HH:mm:ss if the time is available - this won't be displayed if it isn't). This is assumed to be in UTC - `valueString` string: String metadata value ## Other responses - `400`: Invalid status value ## Changes - **2026-03-26** `3389bb785ab9`: 1 info - endpoint added [Operation history](https://skmtc.dev/hm-courts-and-tribunals-service/apis/appeals-interface/changes/applicationStatus/getBySearchParameters/post.md) --- [API](https://skmtc.dev/hm-courts-and-tribunals-service/apis/appeals-interface.md) - [All operations](https://skmtc.dev/hm-courts-and-tribunals-service/apis/appeals-interface/llms.txt) - [OpenAPI document](https://skmtc.dev/hm-courts-and-tribunals-service/apis/appeals-interface/revisions/0b0977ebe459?raw)