{"openapi":"3.1.0","info":{"description":"Deed poll case management API","license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"title":"deed-poll-api","version":"v0.0.1"},"externalDocs":{"description":"README","url":"https://github.com/hmcts/deed-poll-api"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/":{"get":{"operationId":"welcome","responses":{"200":{"content":{"*/*":{"schema":{"type":"string"}}},"description":"OK"}},"security":[],"tags":["root-controller"]}},"/caseworker/cases":{"get":{"operationId":"cases","parameters":[{"in":"query","name":"filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseListResponse"}}},"description":"OK"}},"tags":["caseworker-read-controller"]},"post":{"operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCaseRequest"}}},"required":true},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SavedCaseResponse"}}},"description":"Created"}},"tags":["caseworker-case-controller"]}},"/caseworker/cases/field-rules":{"get":{"operationId":"fieldRules","parameters":[{"in":"query","name":"type","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"migrated","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"publishToGazette","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FieldRulesResponse"}}},"description":"OK"}},"tags":["caseworker-read-controller"]}},"/caseworker/cases/{id}":{"get":{"operationId":"caseDetail","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseDetailResponse"}}},"description":"OK"}},"tags":["caseworker-read-controller"]},"patch":{"operationId":"update","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCaseRequest"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SavedCaseResponse"}}},"description":"OK"}},"tags":["caseworker-case-controller"]}},"/caseworker/cases/{id}/documents":{"post":{"operationId":"upload","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"direction":{"type":"string","description":"Whether the document was received or sent. Optional.","enum":["Incoming","Outgoing"]},"documentTypeId":{"type":"string","format":"uuid","description":"The document type this file is filed under. Must be an existing type, or 404. A type's applicability to the case's marital status and deed poll type is advisory -- it is what a form filters its options by, and the service does not enforce it."},"file":{"type":"string","format":"binary","description":"The file. A PDF, image or Word document, within the configured size limit."},"name":{"type":"string","description":"An optional display name. Defaults to the uploaded filename, capped to the column."}},"required":["documentTypeId"]}}},"description":"The file and the document row to record against it.","required":true},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}},"description":"Created"}},"tags":["caseworker-document-controller"]}},"/caseworker/cases/{id}/documents/{documentId}/file":{"get":{"operationId":"file","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"string","format":"binary"}}},"description":"OK"}},"tags":["caseworker-document-controller"]}},"/caseworker/cases/{id}/notes":{"get":{"operationId":"notes","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NoteResponse"}}}},"description":"OK"}},"tags":["caseworker-note-controller"]},"post":{"operationId":"create_1","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNoteRequest"}}},"required":true},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}},"description":"Created"}},"tags":["caseworker-note-controller"]}},"/caseworker/cases/{id}/notes/{noteId}":{"delete":{"operationId":"delete","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"noteId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["caseworker-note-controller"]},"get":{"operationId":"note","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"noteId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}},"description":"OK"}},"tags":["caseworker-note-controller"]},"patch":{"operationId":"update_1","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"noteId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNoteRequest"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}},"description":"OK"}},"tags":["caseworker-note-controller"]}},"/caseworker/document-types":{"get":{"operationId":"documentTypes","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeResponse"}}}},"description":"OK"}},"tags":["caseworker-read-controller"]}}},"components":{"schemas":{"CaseDetailResponse":{"type":"object","properties":{"ageOfMinor":{"type":"integer","format":"int32"},"ageOfMinorMonths":{"type":"integer","format":"int32"},"andAlsoMyOld":{"type":"array","items":{"type":"integer","format":"int32"}},"applicantAddress1":{"type":"string"},"applicantAddress2":{"type":"string"},"applicantBuildingNoName":{"type":"string"},"applicantEmail":{"type":"string"},"applicantPostcode":{"type":"string"},"applicantTelephone":{"type":"string"},"applicantTownCity":{"type":"string"},"awaitingFurtherDocsInfo":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"dateDecisionDirectionsReceived":{"type":"string","format":"date-time"},"dateEnroled":{"type":"string","format":"date-time"},"dateNoticeSentToLondonGazette":{"type":"string","format":"date-time"},"dateOfApplication":{"type":"string","format":"date-time"},"dateOfDeclaration":{"type":"string","format":"date-time"},"dateOfRefund":{"type":"string","format":"date-time"},"dateReadyForMaster":{"type":"string","format":"date-time"},"dateReceived":{"type":"string","format":"date-time"},"dateReferred":{"type":"string","format":"date-time"},"dateReturned":{"type":"string","format":"date-time"},"daysReceivedToEnroled":{"type":"integer","format":"int32"},"daysReceivedToReturned":{"type":"integer","format":"int32"},"displayReference":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResponse"}},"feeReference":{"type":"string"},"iHaveSubscribed":{"type":"array","items":{"type":"integer","format":"int32"}},"iShall":{"type":"array","items":{"type":"integer","format":"int32"}},"id":{"type":"string"},"inPerson":{"type":"boolean"},"maritalStatus":{"type":"string","enum":["Single","MarriedCivilPartnership","Widowed","DivorcedDissolved"]},"masterDateOfDecision":{"type":"string","format":"date-time"},"masterDecision":{"type":"string","enum":["Approved","Rejected"]},"masterDirections":{"type":"string"},"masterName":{"type":"string"},"migratedRecord":{"type":"boolean"},"minorDateOfBirth":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"nationality":{"type":"string","enum":["BritishCitizen","BritishDependantTerritoriesCitizen","CommonwealthCitizen","Unknown"]},"nationalitySection":{"type":"string","enum":["Section1","Section11","Section37","Section6","Unknown","NoneOfTheAbove"]},"nationalitySectionOther":{"type":"string"},"newForename":{"type":"string"},"newMiddleName":{"type":"string"},"newSurname":{"type":"string"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/NoteResponse"}},"oldForename":{"type":"string"},"oldMiddleName":{"type":"string"},"oldSurname":{"type":"string"},"onlineApplicationReference":{"type":"string"},"parents":{"type":"string"},"postCounter":{"type":"string","enum":["Counter","Online","Post","Unknown"]},"privacy":{"type":"string","enum":["Normal","Private"]},"publishToLondonGazette":{"type":"boolean"},"referToMasterChoice":{"type":"string","enum":["Yes","No"]},"referencenumber":{"type":"integer","format":"int32"},"referralNotes":{"type":"string"},"refundAmount":{"type":"number"},"refundReference":{"type":"string"},"representativeAddress1":{"type":"string"},"representativeAddress2":{"type":"string"},"representativeBuildingNoName":{"type":"string"},"representativeCompany":{"type":"string"},"representativeEmail":{"type":"string"},"representativeName":{"type":"string"},"representativePostcode":{"type":"string"},"representativeTelephone":{"type":"string"},"representativeTownCity":{"type":"string"},"retainPermanently":{"type":"boolean"},"returnReason":{"type":"string"},"signatureReceivedDate":{"type":"string","format":"date-time"},"signatureRequestedDate":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["Received","ReadyForMaster","ReferredToMaster","Enroled","Returned","AwaitingFurtherDocs","AwaitingSignature","AwaitingEnrolment"]},"type":{"type":"string","enum":["Adult","AdultTransgender","Minor","MinorTransgender","DeedOfRelinquishment","Unknown"]},"urgency":{"type":"string","enum":["Normal","Urgent"]},"urgencyreason":{"type":"string"},"witnesses":{"type":"array","items":{"$ref":"#/components/schemas/WitnessResponse"}}}},"CaseListResponse":{"type":"object","properties":{"cases":{"type":"array","items":{"$ref":"#/components/schemas/CaseSummaryResponse"}},"filter":{"type":"string"}}},"CaseSummaryResponse":{"type":"object","properties":{"dateReceived":{"type":"string","format":"date-time"},"displayReference":{"type":"string"},"id":{"type":"string"},"newForename":{"type":"string"},"privacy":{"type":"string","enum":["Normal","Private"]},"state":{"type":"string","enum":["Received","ReadyForMaster","ReferredToMaster","Enroled","Returned","AwaitingFurtherDocs","AwaitingSignature","AwaitingEnrolment"]},"type":{"type":"string","enum":["Adult","AdultTransgender","Minor","MinorTransgender","DeedOfRelinquishment","Unknown"]}}},"CreateCaseRequest":{"additionalProperties":true,"description":"Every field is optional: a case is logged incrementally. An omitted field is left alone and an explicit null clears the column, where the column is nullable. Unknown keys are ignored. dateReceived is needed to allocate a reference number, so a create without it is a 400 attributed to that field.","properties":{"ageOfMinor":{"type":["integer","null"],"format":"int32"},"ageOfMinorMonths":{"type":["integer","null"],"format":"int32"},"andAlsoMyOld":{"type":"array","items":{"type":"integer","format":"int32"}},"applicantAddress1":{"type":["string","null"]},"applicantAddress2":{"type":["string","null"]},"applicantBuildingNoName":{"type":["string","null"]},"applicantEmail":{"type":["string","null"]},"applicantPostcode":{"type":["string","null"]},"applicantTelephone":{"type":["string","null"]},"applicantTownCity":{"type":["string","null"]},"awaitingFurtherDocsInfo":{"type":["string","null"],"format":"date-time"},"dateDecisionDirectionsReceived":{"type":["string","null"],"format":"date-time"},"dateEnroled":{"type":["string","null"],"format":"date-time"},"dateNoticeSentToLondonGazette":{"type":["string","null"],"format":"date-time"},"dateOfApplication":{"type":["string","null"],"format":"date-time"},"dateOfDeclaration":{"type":["string","null"],"format":"date-time"},"dateOfRefund":{"type":["string","null"],"format":"date-time"},"dateReadyForMaster":{"type":["string","null"],"format":"date-time"},"dateReceived":{"type":["string","null"],"format":"date-time"},"dateReferred":{"type":["string","null"],"format":"date-time"},"dateReturned":{"type":["string","null"],"format":"date-time"},"feeReference":{"type":["string","null"]},"iHaveSubscribed":{"type":"array","items":{"type":"integer","format":"int32"}},"iShall":{"type":"array","items":{"type":"integer","format":"int32"}},"inPerson":{"type":["boolean","null"]},"maritalStatus":{"type":["string","null"],"enum":["Single","MarriedCivilPartnership","Widowed","DivorcedDissolved",null]},"masterDateOfDecision":{"type":["string","null"],"format":"date-time"},"masterDecision":{"type":["string","null"],"enum":["Approved","Rejected",null]},"masterDirections":{"type":["string","null"]},"masterName":{"type":["string","null"]},"migratedRecord":{"type":"boolean"},"minorDateOfBirth":{"type":["string","null"],"format":"date-time"},"nationality":{"type":["string","null"],"enum":["BritishCitizen","BritishDependantTerritoriesCitizen","CommonwealthCitizen","Unknown",null]},"nationalitySection":{"type":["string","null"],"enum":["Section1","Section11","Section37","Section6","Unknown","NoneOfTheAbove",null]},"nationalitySectionOther":{"type":["string","null"]},"newForename":{"type":["string","null"],"maxLength":1000},"newMiddleName":{"type":["string","null"],"maxLength":1000},"newSurname":{"type":["string","null"],"maxLength":1000},"oldForename":{"type":["string","null"],"maxLength":1000},"oldMiddleName":{"type":["string","null"],"maxLength":1000},"oldSurname":{"type":["string","null"],"maxLength":1000},"onlineApplicationReference":{"type":["string","null"]},"parents":{"type":["string","null"]},"postCounter":{"type":["string","null"],"enum":["Counter","Online","Post","Unknown",null]},"privacy":{"type":"string","enum":["Normal","Private"]},"publishToLondonGazette":{"type":"boolean"},"referToMasterChoice":{"type":["string","null"],"enum":["Yes","No",null]},"referralNotes":{"type":["string","null"]},"refundAmount":{"type":["number","null"]},"refundReference":{"type":["string","null"]},"representativeAddress1":{"type":["string","null"]},"representativeAddress2":{"type":["string","null"]},"representativeBuildingNoName":{"type":["string","null"]},"representativeCompany":{"type":["string","null"]},"representativeEmail":{"type":["string","null"]},"representativeName":{"type":["string","null"]},"representativePostcode":{"type":["string","null"]},"representativeTelephone":{"type":["string","null"]},"representativeTownCity":{"type":["string","null"]},"retainPermanently":{"type":"boolean"},"returnReason":{"type":["string","null"]},"signatureReceivedDate":{"type":["string","null"],"format":"date-time"},"signatureRequestedDate":{"type":["string","null"],"format":"date-time"},"state":{"type":["string","null"],"enum":["Received","ReadyForMaster","ReferredToMaster","Enroled","Returned","AwaitingFurtherDocs","AwaitingSignature","AwaitingEnrolment",null]},"type":{"type":["string","null"],"enum":["Adult","AdultTransgender","Minor","MinorTransgender","DeedOfRelinquishment","Unknown",null]},"urgency":{"type":"string","enum":["Normal","Urgent"]},"urgencyreason":{"type":["string","null"]}}},"CreateNoteRequest":{"additionalProperties":true,"description":"The note text. Trimmed before validation, and the trimmed value is what is stored. The author comes from the caller's token and the case from the path, so neither can be set here. Unknown keys are ignored.","properties":{"note":{"type":"string","maxLength":2000,"minLength":1}},"required":["note"]},"DocumentResponse":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time"},"direction":{"type":"string","enum":["Incoming","Outgoing"]},"documentType":{"$ref":"#/components/schemas/DocumentTypeResponse"},"hasFile":{"type":"boolean"},"id":{"type":"string"},"mimeType":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"name":{"type":"string"},"originalName":{"type":"string"},"sizeBytes":{"type":"integer","format":"int32"}}},"DocumentTypeResponse":{"type":"object","properties":{"applicableMaritalStatuses":{"type":"array","items":{"type":"integer","format":"int32"}},"applicableTypes":{"type":"array","items":{"type":"integer","format":"int32"}},"id":{"type":"string"},"name":{"type":"string"}}},"FieldRuleResponse":{"type":"object","properties":{"required":{"type":"boolean"},"visible":{"type":"boolean"}}},"FieldRulesResponse":{"type":"object","properties":{"rules":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FieldRuleResponse"}}}},"NoteResponse":{"type":"object","properties":{"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"id":{"type":"string"},"modifiedBy":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"note":{"type":"string"}}},"SavedCaseResponse":{"type":"object","properties":{"ageOfMinor":{"type":"integer","format":"int32"},"ageOfMinorMonths":{"type":"integer","format":"int32"},"andAlsoMyOld":{"type":"array","items":{"type":"integer","format":"int32"}},"applicantAddress1":{"type":"string"},"applicantAddress2":{"type":"string"},"applicantBuildingNoName":{"type":"string"},"applicantEmail":{"type":"string"},"applicantPostcode":{"type":"string"},"applicantTelephone":{"type":"string"},"applicantTownCity":{"type":"string"},"awaitingFurtherDocsInfo":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"dateDecisionDirectionsReceived":{"type":"string","format":"date-time"},"dateEnroled":{"type":"string","format":"date-time"},"dateNoticeSentToLondonGazette":{"type":"string","format":"date-time"},"dateOfApplication":{"type":"string","format":"date-time"},"dateOfDeclaration":{"type":"string","format":"date-time"},"dateOfRefund":{"type":"string","format":"date-time"},"dateReadyForMaster":{"type":"string","format":"date-time"},"dateReceived":{"type":"string","format":"date-time"},"dateReferred":{"type":"string","format":"date-time"},"dateReturned":{"type":"string","format":"date-time"},"daysReceivedToEnroled":{"type":"integer","format":"int32"},"daysReceivedToReturned":{"type":"integer","format":"int32"},"displayReference":{"type":"string"},"feeReference":{"type":"string"},"iHaveSubscribed":{"type":"array","items":{"type":"integer","format":"int32"}},"iShall":{"type":"array","items":{"type":"integer","format":"int32"}},"id":{"type":"string"},"inPerson":{"type":"boolean"},"maritalStatus":{"type":"string","enum":["Single","MarriedCivilPartnership","Widowed","DivorcedDissolved"]},"masterDateOfDecision":{"type":"string","format":"date-time"},"masterDecision":{"type":"string","enum":["Approved","Rejected"]},"masterDirections":{"type":"string"},"masterName":{"type":"string"},"migratedRecord":{"type":"boolean"},"minorDateOfBirth":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"nationality":{"type":"string","enum":["BritishCitizen","BritishDependantTerritoriesCitizen","CommonwealthCitizen","Unknown"]},"nationalitySection":{"type":"string","enum":["Section1","Section11","Section37","Section6","Unknown","NoneOfTheAbove"]},"nationalitySectionOther":{"type":"string"},"newForename":{"type":"string"},"newMiddleName":{"type":"string"},"newSurname":{"type":"string"},"oldForename":{"type":"string"},"oldMiddleName":{"type":"string"},"oldSurname":{"type":"string"},"onlineApplicationReference":{"type":"string"},"parents":{"type":"string"},"postCounter":{"type":"string","enum":["Counter","Online","Post","Unknown"]},"privacy":{"type":"string","enum":["Normal","Private"]},"publishToLondonGazette":{"type":"boolean"},"referToMasterChoice":{"type":"string","enum":["Yes","No"]},"referencenumber":{"type":"integer","format":"int32"},"referralNotes":{"type":"string"},"refundAmount":{"type":"number"},"refundReference":{"type":"string"},"representativeAddress1":{"type":"string"},"representativeAddress2":{"type":"string"},"representativeBuildingNoName":{"type":"string"},"representativeCompany":{"type":"string"},"representativeEmail":{"type":"string"},"representativeName":{"type":"string"},"representativePostcode":{"type":"string"},"representativeTelephone":{"type":"string"},"representativeTownCity":{"type":"string"},"retainPermanently":{"type":"boolean"},"returnReason":{"type":"string"},"signatureReceivedDate":{"type":"string","format":"date-time"},"signatureRequestedDate":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["Received","ReadyForMaster","ReferredToMaster","Enroled","Returned","AwaitingFurtherDocs","AwaitingSignature","AwaitingEnrolment"]},"type":{"type":"string","enum":["Adult","AdultTransgender","Minor","MinorTransgender","DeedOfRelinquishment","Unknown"]},"urgency":{"type":"string","enum":["Normal","Urgent"]},"urgencyreason":{"type":"string"}}},"UpdateCaseRequest":{"additionalProperties":true,"description":"A patch: an omitted field is left alone, an explicit null clears the column where the column is nullable, and unknown keys are ignored. referencenumber, displayReference and the audit columns are not writable. privacy is honoured only for a caller entitled to set it, and state is re-derived from the merged dates.","properties":{"ageOfMinor":{"type":["integer","null"],"format":"int32"},"ageOfMinorMonths":{"type":["integer","null"],"format":"int32"},"andAlsoMyOld":{"type":"array","items":{"type":"integer","format":"int32"}},"applicantAddress1":{"type":["string","null"]},"applicantAddress2":{"type":["string","null"]},"applicantBuildingNoName":{"type":["string","null"]},"applicantEmail":{"type":["string","null"]},"applicantPostcode":{"type":["string","null"]},"applicantTelephone":{"type":["string","null"]},"applicantTownCity":{"type":["string","null"]},"awaitingFurtherDocsInfo":{"type":["string","null"],"format":"date-time"},"dateDecisionDirectionsReceived":{"type":["string","null"],"format":"date-time"},"dateEnroled":{"type":["string","null"],"format":"date-time"},"dateNoticeSentToLondonGazette":{"type":["string","null"],"format":"date-time"},"dateOfApplication":{"type":["string","null"],"format":"date-time"},"dateOfDeclaration":{"type":["string","null"],"format":"date-time"},"dateOfRefund":{"type":["string","null"],"format":"date-time"},"dateReadyForMaster":{"type":["string","null"],"format":"date-time"},"dateReceived":{"type":["string","null"],"format":"date-time"},"dateReferred":{"type":["string","null"],"format":"date-time"},"dateReturned":{"type":["string","null"],"format":"date-time"},"feeReference":{"type":["string","null"]},"iHaveSubscribed":{"type":"array","items":{"type":"integer","format":"int32"}},"iShall":{"type":"array","items":{"type":"integer","format":"int32"}},"inPerson":{"type":["boolean","null"]},"maritalStatus":{"type":["string","null"],"enum":["Single","MarriedCivilPartnership","Widowed","DivorcedDissolved",null]},"masterDateOfDecision":{"type":["string","null"],"format":"date-time"},"masterDecision":{"type":["string","null"],"enum":["Approved","Rejected",null]},"masterDirections":{"type":["string","null"]},"masterName":{"type":["string","null"]},"migratedRecord":{"type":"boolean"},"minorDateOfBirth":{"type":["string","null"],"format":"date-time"},"nationality":{"type":["string","null"],"enum":["BritishCitizen","BritishDependantTerritoriesCitizen","CommonwealthCitizen","Unknown",null]},"nationalitySection":{"type":["string","null"],"enum":["Section1","Section11","Section37","Section6","Unknown","NoneOfTheAbove",null]},"nationalitySectionOther":{"type":["string","null"]},"newForename":{"type":["string","null"],"maxLength":1000},"newMiddleName":{"type":["string","null"],"maxLength":1000},"newSurname":{"type":["string","null"],"maxLength":1000},"oldForename":{"type":["string","null"],"maxLength":1000},"oldMiddleName":{"type":["string","null"],"maxLength":1000},"oldSurname":{"type":["string","null"],"maxLength":1000},"onlineApplicationReference":{"type":["string","null"]},"parents":{"type":["string","null"]},"postCounter":{"type":["string","null"],"enum":["Counter","Online","Post","Unknown",null]},"privacy":{"type":"string","enum":["Normal","Private"]},"publishToLondonGazette":{"type":"boolean"},"referToMasterChoice":{"type":["string","null"],"enum":["Yes","No",null]},"referralNotes":{"type":["string","null"]},"refundAmount":{"type":["number","null"]},"refundReference":{"type":["string","null"]},"representativeAddress1":{"type":["string","null"]},"representativeAddress2":{"type":["string","null"]},"representativeBuildingNoName":{"type":["string","null"]},"representativeCompany":{"type":["string","null"]},"representativeEmail":{"type":["string","null"]},"representativeName":{"type":["string","null"]},"representativePostcode":{"type":["string","null"]},"representativeTelephone":{"type":["string","null"]},"representativeTownCity":{"type":["string","null"]},"retainPermanently":{"type":"boolean"},"returnReason":{"type":["string","null"]},"signatureReceivedDate":{"type":["string","null"],"format":"date-time"},"signatureRequestedDate":{"type":["string","null"],"format":"date-time"},"state":{"type":["string","null"],"enum":["Received","ReadyForMaster","ReferredToMaster","Enroled","Returned","AwaitingFurtherDocs","AwaitingSignature","AwaitingEnrolment",null]},"type":{"type":["string","null"],"enum":["Adult","AdultTransgender","Minor","MinorTransgender","DeedOfRelinquishment","Unknown",null]},"urgency":{"type":"string","enum":["Normal","Urgent"]},"urgencyreason":{"type":["string","null"]}}},"UpdateNoteRequest":{"additionalProperties":true,"description":"An empty patch is accepted and re-stamps modifiedBy. An explicit null for note is a 400, not a clear: the column is NOT NULL. Unknown keys are ignored.","properties":{"note":{"type":"string","maxLength":2000,"minLength":1}}},"WitnessResponse":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time"},"declarant":{"type":"boolean"},"id":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"witnessAddress":{"type":"string"},"witnessName":{"type":"string"},"witnessOccupation":{"type":"string"}}}},"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","description":"A forwarded IDAM access token.","scheme":"bearer","type":"http"}}}}