Goodlord
Goodlord Insurance App API

A second real Goodlord API surface, discovered outside the developer portal. The Goodlord Insurance App is an API Platform (Symfony) service whose OpenAPI 3.1.0 document is served publicly and unauthenticated at /api/v1/docs with the application/vnd.openapi+json media type. It covers rent protection insurance claims handling — insurance claims and claim submission, claim file upload and deletion, claim payments, rent schedules and rent schedule rows, plus agents, companies, roles and role groups. All 21 operations are gated by a JWT in the Authorization header and every collection probe returned HTTP 401. Goodlord does not list this API in its developer portal catalogue and publishes no onboarding path for it, so the contract is public but the API itself is an internal application surface, not an offered developer product.
Documentation GitHub OpenAPI
OpenAPI Specification

{"openapi":"3.1.0","info":{"title":"Insurance App","description":"","version":"0.1.0"},"servers":[{"url":"https:\/\/insurance-app.goodlord.co\/","description":"Development"},{"url":"https:\/\/insurance-app.staging.goodoverlord.com\/","description":"Staging"},{"url":"https:\/\/insurance-app.qa1.goodoverlord.com\/","description":"QA1"},{"url":"https:\/\/insurance-app.demo.goodlord.co\/","description":"Demo"}],"paths":{"\/api\/v1\/agents":{"get":{"operationId":"api_agents_get_collection","tags":["Agent"],"responses":{"200":{"description":"Agent collection","content":{"application\/vnd.api+json":{"schema":{"description":"Agent.jsonapi collection.","allOf":[{"$ref":"#\/components\/schemas\/JsonApiCollectionBaseSchema"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#\/components\/schemas\/Agent"},"relationships":{"type":"object","properties":{"companies":{"properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string","format":"iri-reference"}}}}}}}}},"required":["type","id"]}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Agent-agent_user.read"}}},"text\/csv":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Agent.csv-agent_user.read"}}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves the collection of Agent resources.","description":"Retrieves the collection of Agent resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":50,"minimum":0,"maximum":100},"style":"form","explode":false}]},"post":{"operationId":"api_agents_post","tags":["Agent"],"responses":{"201":{"description":"Agent resource created","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Agent"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/Agent.csv"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"links":{}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Creates a Agent resource.","description":"Creates a Agent resource.","parameters":[],"requestBody":{"description":"The new Agent resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Agent"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/Agent.csv"}}},"required":true}}},"\/api\/v1\/agents\/{id}":{"get":{"operationId":"api_agents_id_get","tags":["Agent"],"responses":{"200":{"description":"Agent resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Agent-agent_user.read"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/Agent.csv-agent_user.read"}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a Agent resource.","description":"Retrieves a Agent resource.","parameters":[{"name":"id","in":"path","description":"Agent identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_agents_id_patch","tags":["Agent"],"responses":{"200":{"description":"Agent resource updated","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Agent"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/Agent.csv"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"links":{}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Updates the Agent resource.","description":"Updates the Agent resource.","parameters":[{"name":"id","in":"path","description":"Agent identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Agent resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.jsonapi"}},"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.jsonMergePatch"}}},"required":true}}},"\/api\/v1\/me":{"get":{"operationId":"get_me","tags":["Agent"],"responses":{"200":{"description":"Agent resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Agent.AppUserGetDto.jsonapi-me.get"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Agent.UserWithClaimData-me.get"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/Agent.UserWithClaimData.csv-me.get"}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a Agent resource.","description":"Retrieves a Agent resource.","parameters":[{"name":"include","in":"query","description":"Agent include","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}},"\/api\/v1\/companies":{"get":{"operationId":"api_companies_get_collection","tags":["Company"],"responses":{"200":{"description":"Company collection","content":{"application\/vnd.api+json":{"schema":{"description":"Company.jsonapi collection.","allOf":[{"$ref":"#\/components\/schemas\/JsonApiCollectionBaseSchema"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#\/components\/schemas\/Company"}},"required":["type","id"]}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Company"}}},"text\/csv":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Company.csv"}}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves the collection of Company resources.","description":"Retrieves the collection of Company resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":50,"minimum":0,"maximum":100},"style":"form","explode":false}]}},"\/api\/v1\/companies\/{id}":{"get":{"operationId":"api_companies_id_get","tags":["Company"],"responses":{"200":{"description":"Company resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Company.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Company"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/Company.csv"}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a Company resource.","description":"Retrieves a Company resource.","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"\/api\/v1\/insurance_claims\/{insuranceClaimId}\/files":{"get":{"operationId":"api_insurance_claims_insuranceClaimIdfiles_get_collection","tags":["File"],"responses":{"200":{"description":"File collection","content":{"application\/vnd.api+json":{"schema":{"description":"File.jsonapi collection.","allOf":[{"$ref":"#\/components\/schemas\/JsonApiCollectionBaseSchema"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#\/components\/schemas\/File"},"relationships":{"type":"object","properties":{"insuranceClaim":{"properties":{"data":{"oneOf":[{"type":"null"},{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string","format":"iri-reference"}}}]}}}}}},"required":["type","id"]}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/File-file.read"}}},"text\/csv":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/File.csv-file.read"}}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves the collection of File resources.","description":"Retrieves the collection of File resources.","parameters":[{"name":"insuranceClaimId","in":"path","description":"File identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":50,"minimum":0,"maximum":100},"style":"form","explode":false}]},"post":{"operationId":"api_insurance_claims_insuranceClaimIdfiles_post","tags":["File"],"responses":{"201":{"description":"FileCreate resource created","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/FileCreate.FilePostDto.jsonapi"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"links":{}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Upload a file to an insurance claim","description":"Upload a file (tenancy agreement, rent schedule, or supporting document)\n                to an insurance claim. The file will be stored and synced to Podio.","parameters":[{"name":"insuranceClaimId","in":"path","description":"FileCreate identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"File upload data","content":{"multipart\/form-data":{"schema":{"type":"object","required":["file","file_type"],"properties":{"file":{"type":"string","format":"binary","description":"The file to upload"},"file_type":{"type":"string","enum":["tenancy-agreement-original","rent-schedule","supporting-document"],"description":"The type of file being uploaded"}}}}},"required":true}}},"\/api\/v1\/insurance_claims\/{insuranceClaimId}\/files\/{id}":{"get":{"operationId":"api_insurance_claims_insuranceClaimIdfiles_id_get","tags":["File"],"responses":{"200":{"description":"File resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/File.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/File-file.read"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/File.csv-file.read"}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a File resource.","description":"Retrieves a File resource.","parameters":[{"name":"insuranceClaimId","in":"path","description":"File identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"File identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_insurance_claims_insuranceClaimIdfiles_id_delete","tags":["File"],"responses":{"204":{"description":"File resource deleted"},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Removes the File resource.","description":"Removes the File resource.","parameters":[{"name":"insuranceClaimId","in":"path","description":"File identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"File identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"\/api\/v1\/insurance_claims":{"get":{"operationId":"api_insurance_claims_get_collection","tags":["InsuranceClaim"],"responses":{"200":{"description":"InsuranceClaim collection","content":{"application\/vnd.api+json":{"schema":{"description":"InsuranceClaim.jsonapi collection.","allOf":[{"$ref":"#\/components\/schemas\/JsonApiCollectionBaseSchema"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#\/components\/schemas\/InsuranceClaim"},"relationships":{"type":"object","properties":{"company":{"properties":{"data":{"oneOf":[{"type":"null"},{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string","format":"iri-reference"}}}]}}},"rentSchedule":{"properties":{"data":{"oneOf":[{"type":"null"},{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string","format":"iri-reference"}}}]}}},"files":{"properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string","format":"iri-reference"}}}}}},"payments":{"properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string","format":"iri-reference"}}}}}}}}},"required":["type","id"]}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/InsuranceClaim-insurance_claim.read"}}},"text\/csv":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/InsuranceClaim.csv-insurance_claim.read"}}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves the collection of InsuranceClaim resources.","description":"Retrieves the collection of InsuranceClaim resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":50,"minimum":0,"maximum":100},"style":"form","explode":false},{"name":"company.externalId","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"company.externalId[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"policyUniqueReferenceNumber[]","in":"query","description":"Filter insurance claims by policy unique reference number (RPI ref)","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"policyUniqueReferenceNumber","in":"query","description":"Filter insurance claims by policy unique reference number (RPI ref)","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"propertyAddress","in":"query","description":"Filter insurance claims by address","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"claimStatus[]","in":"query","description":"Filter insurance claims by status","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"claimStatus","in":"query","description":"Filter insurance claims by status","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"order[totalPaymentAmount]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[claimDate]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[latestPaymentDate]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"include","in":"query","description":"Which relations to include in the response","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false,"example":"company,files,payments"}]},"post":{"operationId":"api_insurance_claims_post","tags":["InsuranceClaim"],"responses":{"201":{"description":"InsuranceClaimCreate resource created","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaimCreate.InsuranceClaimPostDto.jsonapi-insurance_claim.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaimCreate.InsuranceClaimGetDto-insurance_claim.read"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaimCreate.InsuranceClaimGetDto.csv-insurance_claim.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"links":{}}},"summary":"Creates a InsuranceClaimCreate resource.","description":"Creates a InsuranceClaimCreate resource.","parameters":[],"requestBody":{"description":"The new InsuranceClaimCreate resource","content":{"application\/vnd.api+json":{"example":{"data":{"type":"InsuranceClaimCreate","attributes":{"policyId":1,"propertyAddress":{"line1":"123 Main St","line2":"London","line3":"string","postcode":"SW1A 1AA","country":"England"},"typeOfClaim":"Rent Arrears","rpiUniqueReferenceNumber":"RPI-123456","companyExternalId":1}}}}},"required":false}}},"\/api\/v1\/insurance_claims\/{id}":{"get":{"operationId":"api_insurance_claims_id_get","tags":["InsuranceClaim"],"responses":{"200":{"description":"InsuranceClaim resource","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaim.jsonapi"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaim-insurance_claim.read"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaim.csv-insurance_claim.read"}}}},"403":{"description":"Forbidden","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a InsuranceClaim resource.","description":"Retrieves a InsuranceClaim resource.","parameters":[{"name":"id","in":"path","description":"InsuranceClaim identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"include","in":"query","description":"Which relations to include in the response","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false,"example":"company,files,payments"}]},"patch":{"operationId":"api_insurance_claims_id_patch","tags":["InsuranceClaim"],"responses":{"200":{"description":"InsuranceClaimUpdate resource updated","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaimUpdate.InsuranceClaimPatchDto.jsonapi-insurance_claim.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaimUpdate.InsuranceClaimGetDto-insurance_claim.read"}},"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/InsuranceClaimUpdate.InsuranceClaimGetDto.csv-insurance_claim.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"links":{}},"404":{"description":"Not found","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonapi"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Update insurance claim details","description":"Partially update an insurance claim. Only included fields are modified.","parameters":[{"name":"id","in":"path","description":"InsuranceClaimUpdate identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"File upload data","content":{"application\/vnd.api+json":{"example":{"data":{"type":"InsuranceClaimUpdate","id":"\/api\/v1\/insurance_claims\/550e8400-e29b-41d4-a716-446655440000","attributes":{"agencyName":"Updated Agency Name","agentName":"John Smith","agencyEmail":"john@agency.com","agencyPhone":"020 1234 5678","lettingAgentRegistrationNumber":"LARN123456","tenants":[{"name":"John Smith","email":"john@example.com","phone":"+447851000000"},{"name":"Jane Doe","email":"jane@example.com","phone":"+447851000001"}],"propertyAddress":{"line1":"123 New Street","line2":"New Area","line3":"New District","postcode":"SW1A 1AA","country":"England"},"guarantors":[{"name":"Jane Guarantor","address":"123 Guarantor Street","phone":"+447851111111","email":"guarantor@example.com"}],"landlords":[{"name":"John Landlord","address":"456 Landlord Avenue","email":"landlord@example.com","phone":"020 7654 3210"}],"landlordRegistrationNumber":"LARN789","permittedOccupiersName":"Child A, Child B","isTenancyCreatedOnGoodlord":"Yes","isTenancyRemovedAndNowOnFixedTerm":"Periodic","dateBecamePeriodic":"2024-01-15","referencingCompletedByGoodlord":"Yes","isGasAtProperty":"Yes","didUploadEpcToGoodlord":"Yes","dateEpcWasProvidedToTenant":"2024-01-10","howEpcWasGivenToTenant":"Hard copy in person","isEicrOnGoodlord":"Yes","depositType":"Cash deposit","depositCollectedByGoodlord":"Yes","depositPaidBy":"Tenant","dateDepositWasPaid":"2024-01-05","isDepositCertificateOnGoodlord":"Yes","dateDepositProtected":"2024-01-06","prescribedInformationGiven":"Provided in person at tenancy start","depositReplacementCoverLevel":"6 weeks rent","propertyRequiresLicense":"No","dateOfRentArrears":"2024-02-01","rentOutstanding":{"amount":150000,"currency":"GBP"},"reasonForNonPayment":"Tenant lost job","tenantsInDebtRespiteScheme":"No","detailsOfBreach":"Unauthorised subletting","dateAwareOfBreach":"2024-02-15","worksBeingClaimedForDamage":"Repainting, carpet replacement","depositUsedFor":"Rent arrears and damage","datePropertyDamageIdentified":"2024-02-20","currentDisputeInfo":"Tenant disputes damage claim","dateAwareOfDispute":"2024-02-25","trespassOrNuisanceInfo":"N\/A","dateAwareOfTrespassOrNuisance":null,"isPropertyStillOccupied":"No","verificationTenantIsStillOccupyingProperty":"Keys returned, inventory completed","dateLastInspection":"2024-02-28","dateTenantVacated":"2024-02-28","isClaimAgainstDepositFinalisedByDepositScheme":"Yes","isClaimAgainstDepositReplacementFinalised":"Yes","amountAwardedForRentArrears":{"amount":50000,"currency":"GBP"},"depositUseBreakdown":"£500 rent arrears, £200 damage","howDepositClaimWasSettled":"Tenant provided written authorisation for the deductions","depositReplacementUseBreakdown":"£300 rent arrears, £150 damage","forwardingAddress":"123 New Tenant Street, London, SW1A 1AA","agencyInstructedToReLet":"Yes","isPropertyAlreadyReLet":"No","dateNewTenancy":null,"possessionNoticesServed":"Yes","otherNoticesServed":"No","disputesBetweenTenantAndLandlord":"No","detailsOfDisputesBetweenTenantAndLandlord":"Tenant disputes damage assessment","otherRelevantClaimInfo":"Additional context for the claim","noticesServedToLandlord":"No","agencyAccountName":"Acme Lettings","agencyAccountNumber":"12345678","agencySortCode":"12-34-56","remittanceEmail":"remittance@agency.com","gasSafetyCertificates":[{"yearGasCheckCompleted":"2024","dateProvidedToTenants":"2024-03-15","methodOfProvision":"Hard copy in person"},{"yearGasCheckCompleted":"2025","dateProvidedToTenants":"2025-03-20","methodOfProvision":"Email\/Electronic copy"}],"howToRentGuides":[{"guideVersion":"October 2023","dateProvidedToTenant":"2023-11-01","methodOfProvision":"Hard copy by post"},{"guideVersion":"March 2023","dateProvidedToTenant":"2023-04-15","methodOfProvision":"Other"}],"tribunalNotificationDate":"2026-03-01","marketValueExplanation":"Based on comparable local listings within 0.5 miles","firstMonthRentRequestedViaGoodlord":"Yes","keysHandedOverDate":"2026-02-15","tenantOccupationDate":"2026-02-16","detailsOfAntiSocialBehaviour":"Repeated noise complaints from neighbours","dateAwareOfAntiSocialBehaviour":"2026-02-20","rraInfoSheetIssueDate":"2026-04-15","rraInfoSheetIssueMethod":"By Email\/Electronic copy","statementOfTermsInTenancyAgreement":"Yes","statementOfTermsIssuedDate":"2026-04-15","statementOfTermsIssuedMethod":"By Email\/Electronic copy","firstMonthRentRequestedBeforeSigning":"No","firstMonthRentRequestedDate":"2026-04-20","originalTenancyStartDate":"2026-03-01"}}}}},"required":true}}},"\/api\/v1\/insurance_claims\/{id}\/submit":{"post":{"operationId":"api_insurance_claims_idsubmit_post","tags":["InsuranceClaim"],"responses":{"201":{"description":"InsuranceClaim resource created","content":{"application\/vnd.api+json":{"schema":{"$ref":"#\/componen

# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/goodlord/refs/heads/main/openapi/goodlord-insurance-app-api-openapi.json
Goodlord Insurance App API

Documentation

Specifications

Other Resources

OpenAPI Specification
