action credas_add_instant_registration {
  label: "Creates new registration record, adds an ID document and optional selfie image in one go."
  description: "It's designed to provide a quick integration path for external systems which capture these details."
  provider: credas
  method: POST
  path: "/api/registrations/instant"
  encoding: json
  input: {
    type: "object"
    properties: {
      apikey: {
        type: "string"
      }
      document: {
        type: "string"
      }
      documentParameters: {
        type: "array"
        items: {
          type: "object"
          properties: {
            key: {
              type: "string"
            }
            value: {
              type: "string"
            }
          }
        }
      }
      documentType: {
        type: "integer"
        format: "int32"
        description: "Other = 0, Passport = 1, DrivingLicence = 2, Visa = 3, CscsCard = 4, HomeOfficeLetter = 5, BirthCertificate = 6, NationalIdCard = 7, ResidencePermit = 9, UtilityBill = 11"
        enum: [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11]
      }
      forename: {
        type: "string"
      }
      middleName: {
        type: "string"
      }
      parameters: {
        type: "array"
        items: {
          type: "object"
          additionalProperties: true
        }
      }
      referenceId: {
        type: "string"
      }
      regTypeId: {
        type: "string"
        format: "uuid"
      }
      selfie: {
        type: "string"
      }
      significantPersonId: {
        type: "string"
        format: "uuid"
      }
      surname: {
        type: "string"
      }
    }
    required: ["apikey", "document", "documentType", "forename", "regTypeId", "surname"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["documentStatus", "documentType", "facialMatch", "id", "regCode"]
    properties: {
      documentStatus: {
        type: "integer"
        format: "int32"
        description: "Active = 1, Deleted = 2, UnderReview = 3"
        enum: [1, 2, 3]
      }
      documentType: {
        type: "integer"
        format: "int32"
        description: "Unknown = 0, Passport = 1, DrivingLicense = 2, IdentificationCard = 3, TaxLetter = 4, NIC_Letter = 5, TV_Licence = 6, UtilityBill = 7, HighRiskWorkLicence = 8, TravelPermit = 9, BankLetter = 10, BenefitLetter = 11, BankStatement = 12, NINO_Letter = 13, CouncilTax = 14, ResidentPermit = 15, PhotoCard = 16, RepaymentLetter = 17, Invoice = 18, Visa = 19, AgeIdentificationCard = 20, MedicareCard = 21, MilitaryIdentificationCard = 22, UtilityLetter = 23, CouncilDocument = 24, JobLicence = 25, MembershipIDCard = 26, MilitaryIDCard = 27, ProofOfAgeCard = 28, TravelPermitNew = 29, WeaponsLicence = 30, AccountStatement = 41, TenancyAgreement = 42, BankDocument = 43, BankLetterNew = 44, BankStatementNew = 45, BenefitLetterNew = 46, CouncilDocumentNew = 48, CouncilLetter = 49, CouncilTaxNew = 50, DWPDocument = 51, HMRCDocument = 52, InformationSheet = 53, InsuranceDocument = 54, InsuranceLetter = 55, InvoiceNew = 56, NICLetter = 57, NINOLetter = 58, OfficialDocument = 59, OfficialLetter = 60, RepaymentLetterNew = 61, TaxLetterNew = 62, TaxStatement = 63, TelBill = 64, TelLetter = 65, TelecommunicationDocument = 66, TVLicence = 67, UniversityLetter = 68, UtilityBillNew = 69, UtilityDocument = 70, UtilityLetterNew = 71, WaterBill = 72, WaterDocument = 73, HighRiskWorkLicenceNew = 74, PhotoCardNew = 75, MedicareCardNew = 76, Certificate = 77"
        enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77]
      }
      facialMatch: {
        type: "boolean"
      }
      id: {
        type: "string"
        format: "uuid"
      }
      regCode: {
        type: "string"
      }
    }
  }
}