action credas_add_property_register_check {
  label: "Creates new property registry check against the registration."
  provider: credas
  method: POST
  path: "/api/property-register"
  encoding: json
  input: {
    type: "object"
    properties: {
      address: {
        type: "object"
        required: ["addressLine1", "city", "country", "postcode"]
        properties: {
          addressLine1: {
            type: "string"
          }
          addressLine2: {
            type: "string"
          }
          addressLine3: {
            type: "string"
          }
          city: {
            type: "string"
          }
          country: {
            type: "string"
          }
          county: {
            type: "string"
          }
          postcode: {
            type: "string"
          }
        }
      }
      apikey: {
        type: "string"
      }
      person: {
        type: "object"
        required: ["forename", "surname"]
        properties: {
          forename: {
            type: "string"
          }
          middleName: {
            type: "string"
          }
          surname: {
            type: "string"
          }
        }
      }
      regEntryId: {
        type: "string"
        format: "uuid"
      }
    }
    required: ["address", "apikey", "person", "regEntryId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      checkStatus: {
        type: "integer"
        format: "int32"
        description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
        enum: [0, 1, 2, 3]
      }
      hasBeenOverridden: {
        type: "boolean"
      }
      matchResult: {
        type: "integer"
        format: "int32"
        description: "Unknown = 0, FullNameMatch = 1, SurnameMatch = 2, NoNameMatch = 3, NoAddressMatch = 4, TitleNotRegistered = 5, Unavailable = 6, OutOfHours = 7"
        enum: [0, 1, 2, 3, 4, 5, 6, 7]
      }
      matchResultText: {
        type: "string"
      }
      propertyOwnership: {
        type: "integer"
        format: "int32"
        description: "Unknown = 0, SoleOwnership = 1, JointOwnership = 2"
        enum: [0, 1, 2]
      }
      propertyOwnershipText: {
        type: "string"
      }
      titleNumber: {
        type: "string"
      }
    }
  }
}