action credas_check_credit_status {
  label: "Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship."
  provider: credas
  method: POST
  path: "/api/credit-status/perform"
  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: ["dateOfBirth", "forename", "surname"]
        properties: {
          dateOfBirth: {
            type: "string"
            format: "date-time"
          }
          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: {
      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"
          }
        }
      }
      ccj: {
        type: "array"
        items: {
          type: "object"
          properties: {
            address1: {
              type: "string"
            }
            address2: {
              type: "string"
            }
            address3: {
              type: "string"
            }
            address4: {
              type: "string"
            }
            address5: {
              type: "string"
            }
            amount: {
              type: "string"
            }
            caseNumber: {
              type: "string"
            }
            courtName: {
              type: "string"
            }
            dateEnd: {
              type: "string"
              format: "date-time"
            }
            dob: {
              type: "string"
              format: "date-time"
            }
            judgementDate: {
              type: "string"
              format: "date-time"
            }
            judgementType: {
              type: "integer"
              format: "int32"
              description: "Unknown = 0, Judgement = 1, Satisfaction = 2, Revocation = 3, SetAside = 4, AdministrationOrder = 5"
              enum: [0, 1, 2, 3, 4, 5]
            }
            judgementTypeText: {
              type: "string"
            }
            name: {
              type: "string"
            }
            postcode: {
              type: "string"
            }
          }
        }
      }
      checkDate: {
        type: "string"
        format: "date-time"
      }
      companyDirector: {
        type: "array"
        items: {
          type: "object"
          properties: {
            companyAppointments: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  address: {
                    type: "string"
                  }
                  appointmentDate: {
                    type: "string"
                    format: "date-time"
                  }
                  appointmentType: {
                    type: "string"
                  }
                  dob: {
                    type: "string"
                    format: "date-time"
                  }
                  name: {
                    type: "string"
                  }
                  nationality: {
                    type: "string"
                  }
                  occupation: {
                    type: "string"
                  }
                  title: {
                    type: "string"
                  }
                }
              }
            }
            companyName: {
              type: "string"
            }
            companyRegNo: {
              type: "string"
            }
            dateAppointed: {
              type: "string"
              format: "date-time"
            }
            matchType: {
              type: "integer"
              format: "int32"
              description: "Unknown = 0, NameAndDateOfBirth = 1, NameAndAddress = 2, NameAndAddressAndDateOfBirth = 3"
              enum: [0, 1, 2, 3]
            }
            matchTypeText: {
              type: "string"
            }
            registeredOffice: {
              type: "string"
            }
          }
        }
      }
      hasBeenOverridden: {
        type: "boolean"
      }
      insolvency: {
        type: "array"
        items: {
          type: "object"
          properties: {
            address: {
              type: "object"
              properties: {
                address1: {
                  type: "string"
                }
                address2: {
                  type: "string"
                }
                address3: {
                  type: "string"
                }
                address4: {
                  type: "string"
                }
                address5: {
                  type: "string"
                }
                dps: {
                  type: "string"
                }
                isEmpty: {
                  type: "boolean"
                }
                postcode: {
                  type: "string"
                }
              }
            }
            aliases: {
              type: "string"
            }
            assetTotal: {
              type: "string"
            }
            caseNo: {
              type: "string"
            }
            caseType: {
              type: "string"
            }
            court: {
              type: "string"
            }
            debtTotal: {
              type: "string"
            }
            description: {
              type: "string"
            }
            dob: {
              type: "string"
              format: "date-time"
            }
            name: {
              type: "string"
            }
            occupation: {
              type: "string"
            }
            presentationDate: {
              type: "string"
              format: "date-time"
            }
            previousAddress: {
              type: "object"
              additionalProperties: true
            }
            serviceOffice: {
              type: "string"
            }
            startDate: {
              type: "string"
              format: "date-time"
            }
            status: {
              type: "string"
            }
            telephoneNumber: {
              type: "string"
            }
            tradingNames: {
              type: "string"
            }
            type: {
              type: "integer"
              format: "int32"
              description: "Unknown = 0, NorthernIrelandBankruptcy = 1, ScottishSequestrationBankruptcy = 2, EnglandAndWalesIVA = 3, EnglandAndWalesDRO = 4, EnglandAndWalesBankruptcy = 5"
              enum: [0, 1, 2, 3, 4, 5]
            }
            typeText: {
              type: "string"
            }
          }
        }
      }
      person: {
        type: "object"
        required: ["dateOfBirth", "forename", "surname"]
        properties: {
          dateOfBirth: {
            type: "string"
            format: "date-time"
          }
          forename: {
            type: "string"
          }
          middleName: {
            type: "string"
          }
          surname: {
            type: "string"
          }
        }
      }
      status: {
        type: "integer"
        format: "int32"
        description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
        enum: [0, 1, 2, 3]
      }
    }
  }
}