> ## Documentation Index > Fetch the complete documentation index at: https://docs.health-street.net/llms.txt > Use this file to discover all available pages before exploring further. # Update Applicant > Update an existing Applicant ## OpenAPI ````yaml patch /vLatest/action/glasscore/applicant/{id} openapi: 3.1.0 info: version: 2.0.0 title: Health Street API description: >- The Health Street API provides secure and reliable endpoints to manage drug tests, background checks, DNA checks, and occupational health tests. servers: - url: https://api.glass.fm security: [] paths: /vLatest/action/glasscore/applicant/{id}: patch: tags: - Applicant summary: Update Applicant description: Update an existing Applicant operationId: UpdateApplicant parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: type: object properties: aliasNameFirst: type: string description: Stores the first alias or nickname of the applicant. aliasNameLast: type: string description: Stores the last alias or nickname used by the applicant. applicationDate: anyOf: - type: string - type: string description: >- Records the date when the applicant submitted their application. currentAddressYearStart: type: string description: >- The year the applicant began residing at their current address. georgia_race: type: string description: >- Indicates the racial or ethnic identity of the applicant from Georgia. info: type: array items: type: object properties: descrip: type: string description: Description of record. infoItem: type: array items: type: object properties: AttributeId: type: string description: >- Unique identifier for the specific characteristic or property of an information item. choice: type: string description: >- Represents the selected option or decision related to a specific information item. featureSetDescrip: type: string description: >- Contains details about the specific characteristics or attributes of an information item. FeatureSetId: type: number description: >- Unique identifier for a specific set of characteristics or properties associated with an information item. featureSetName: type: string description: >- Represents the group or category to which a specific information item belongs. InfoId: type: number nullable: true description: >- Unique identifier for each information item in the database. PersonId: type: number nullable: true description: >- Unique identifier assigned to each individual in the InfoItem table. valueDate: anyOf: - type: string - type: string description: >- Represents the date associated with the specific information item. valueFeatureId: type: number nullable: true description: >- Identifies the specific characteristic or attribute of the information item. valueNumber: type: number nullable: true description: >- Represents the numerical data associated with a specific information item. valueText: type: string description: >- Stores the textual content or information related to a specific item in the InfoItem table. description: >- Contains specific details or pieces of data related to the information stored in the Info table. isSubmitted: type: number nullable: true description: >- Indicates whether the information in the Info table has been submitted or not. OrderItemId: type: number description: Unique identifier for each item within an order. PersonId: type: number nullable: true description: >- Unique identifier assigned to each individual in the Info table. ProductId: type: number nullable: true description: >- A unique identifier assigned to each product in the Info table. priorAddressCity: type: string description: The city of the applicant's previous residence. priorAddressCounty: type: string description: The county of the applicant's previous address. priorAddressState: type: string description: >- Represents the state of the previous address of the applicant. priorAddressStreetPrimary: type: string description: >- Contains the main street name of the applicant's previous address. priorAddressStreetSecondary: type: string description: >- Contains any additional information about the applicant's previous street address such as apartment or unit number. priorAddressYearEnd: type: string description: >- Represents the year the applicant ended residency at their previous address. priorAddressYearStart: type: string description: >- Indicates the year the applicant began living at their previous address. priorAddressZip: type: string description: >- Contains the postal code of the applicant's previous residence. ssn: type: string description: Stores the unique Social Security Number of the applicant. responses: '200': description: Updated Applicant content: application/json: schema: type: object properties: aliasNameFirst: type: string description: Stores the first alias or nickname of the applicant. aliasNameLast: type: string description: Stores the last alias or nickname used by the applicant. applicationDate: anyOf: - type: string - type: string description: >- Records the date when the applicant submitted their application. currentAddressYearStart: type: string description: >- The year the applicant began residing at their current address. dropResume: type: string description: >- Indicates the location or the action where an applicant's resume is uploaded or dropped off. dropWaiver: type: string description: >- Indicates whether the applicant has requested to waive any requirements or obligations. font: type: string description: >- Specifies the typeface used in the applicant's submitted documents. georgia_race: type: string description: >- Indicates the racial or ethnic identity of the applicant from Georgia. id: type: number description: Unique identifier. id_address1: type: string description: Primary identifier for the first address of the applicant. id_address2: type: string description: >- Represents the secondary address identifier of an applicant. id_birthdate: anyOf: - type: string - type: string description: Stores the date of birth of the applicant. id_cardRevisonDate: anyOf: - type: string - type: string description: >- Represents the date when the applicant's identification card was last updated or revised. id_city: type: string description: >- Represents the unique identifier of the city where the applicant resides. id_classificationCode: type: string description: >- Represents the unique code assigned to categorize an applicant based on certain criteria. id_complianceType: type: string description: >- Indicates the type of compliance required by the applicant. id_country: type: string description: >- Represents the unique identifier of the country where the applicant resides. id_countryCode: type: string description: >- Represents the international code associated with the country of the applicant. id_documentType: type: string description: >- Specifies the type of identification document provided by the applicant. id_endorsementCode: type: string description: >- Represents the unique code associated with the endorsement given to an applicant. id_endorsementCodeDescription: type: string description: >- Contains the explanation or details of the endorsement code associated with the applicant. id_expirationDate: anyOf: - type: string - type: string description: >- Specifies the date on which the applicant's identification document expires. id_firstName: type: string description: Stores the first name of the applicant. id_fullName: type: string description: Contains the complete name of the individual applying. id_gender: type: string description: Represents the gender identity of the applicant. id_hazmatExpDate: anyOf: - type: string - type: string description: >- The expiration date of the hazardous materials handling certification for the applicant. id_idScanErrorMessage: type: string description: >- Stores the error message associated with the applicant's identification scan. id_idScanSuccess: type: number nullable: true description: >- Indicates whether the ID scan of the applicant was successful or not. id_idScanTimestamp: anyOf: - type: string - type: string description: >- Represents the timestamp of when the applicant's identification was scanned. id_IIN: type: string description: >- Represents the unique identification number of the applicant, often referred to as Individual Identification Number (IIN). id_issueDate: anyOf: - type: string - type: string description: >- Represents the date when the applicant's identification was issued. id_issuedBy: type: string description: >- Represents the entity or authority that issued the identification to the applicant. id_jurisdictionCode: type: string description: >- Represents the unique code assigned to the jurisdiction or legal authority under which the applicant falls. id_lastName: type: string description: Stores the surname of the applicant. id_licenseNumber: type: string description: >- Represents the unique identification number of the applicant's license. id_limitedDurationDocument: type: string description: >- Represents the identifier for a document with a limited duration associated with an applicant. id_middleName: type: string description: Contains the middle name of the applicant. id_namePrefix: type: string description: >- Stores the title or salutation (e.g., Mr., Mrs., Dr., etc.) of the applicant. id_nameSuffix: type: string description: >- Refers to the suffix (such as Jr., Sr., III, etc.) associated with the applicant's name. id_postalBox: type: string description: Represents the postal box number of the applicant. id_postalCode: type: string description: Represents the postal code of the applicant. id_requestId: type: string id_restrictionCode: type: string description: >- Represents the specific code associated with any restrictions or limitations applicable to the applicant. id_restrictionCodeDescription: type: string description: >- Contains details about the specific limitations or conditions applicable to the applicant. id_vehicleClassCode: type: string description: >- Represents the classification code of the vehicle associated with the applicant. id_vehicleClassCodeDescription: type: string description: >- Contains the description of the vehicle class code associated with the applicant. id_veteran: type: string description: Indicates whether the applicant is a veteran or not. info: type: array items: type: object properties: id: type: number description: Unique identifier. infoItem: type: array items: type: object properties: AttributeId: type: string description: >- Unique identifier for the specific characteristic or property of an information item. c_attributeField: type: string description: >- Stores the characteristics or properties associated with an information item. choice: type: string description: >- Represents the selected option or decision related to a specific information item. featureSetDescrip: type: string description: >- Contains details about the specific characteristics or attributes of an information item. FeatureSetId: type: number description: >- Unique identifier for a specific set of characteristics or properties associated with an information item. featureSetName: type: string description: >- Represents the group or category to which a specific information item belongs. id: type: number description: Unique identifier. InfoId: type: number nullable: true description: >- Unique identifier for each information item in the database. PersonId: type: number nullable: true description: >- Unique identifier assigned to each individual in the InfoItem table. valueDate: anyOf: - type: string - type: string description: >- Represents the date associated with the specific information item. valueFeatureId: type: number nullable: true description: >- Identifies the specific characteristic or attribute of the information item. valueNumber: type: number nullable: true description: >- Represents the numerical data associated with a specific information item. valueText: type: string description: >- Stores the textual content or information related to a specific item in the InfoItem table. required: - AttributeId - c_attributeField - choice - featureSetDescrip - FeatureSetId - featureSetName - id - InfoId - PersonId - valueDate - valueFeatureId - valueNumber - valueText description: >- Contains specific details or pieces of data related to the information stored in the Info table. isSubmitted: type: number nullable: true description: >- Indicates whether the information in the Info table has been submitted or not. isTransmitted: type: number nullable: true description: >- Indicates whether the information has been sent or not. orderItemDate: anyOf: - type: string - type: string description: >- Represents the date when a specific item was ordered. PersonId: type: number nullable: true description: >- Unique identifier assigned to each individual in the Info table. ProductId: type: number nullable: true description: >- A unique identifier assigned to each product in the Info table. required: - id - infoItem - isSubmitted - isTransmitted - orderItemDate - PersonId - ProductId isDropDriverLicense: type: boolean nullable: true description: >- Indicates whether the applicant has surrendered their driver's license. isDropDriverLicenseBack: type: boolean nullable: true description: >- Indicates whether the applicant has submitted a copy of the back of their driver's license. isDropResume: type: boolean nullable: true description: >- Indicates whether the applicant has submitted their resume or not. isDropSelfie: type: boolean nullable: true description: >- Indicates whether the applicant has submitted a selfie photo for identification purposes. isNoIdScan: type: boolean nullable: true description: >- Indicates whether the applicant's identification was not scanned. PersonId: type: number description: Unique identifier assigned to each individual applicant. priorAddressCity: type: string description: The city of the applicant's previous residence. priorAddressCounty: type: string description: The county of the applicant's previous address. priorAddressState: type: string description: >- Represents the state of the previous address of the applicant. priorAddressStreetPrimary: type: string description: >- Contains the main street name of the applicant's previous address. priorAddressStreetSecondary: type: string description: >- Contains any additional information about the applicant's previous street address such as apartment or unit number. priorAddressYearEnd: type: string description: >- Represents the year the applicant ended residency at their previous address. priorAddressYearStart: type: string description: >- Indicates the year the applicant began living at their previous address. priorAddressZip: type: string description: >- Contains the postal code of the applicant's previous residence. ssn: type: string description: Stores the unique Social Security Number of the applicant. supplementalWaiverDate: anyOf: - type: string - type: string description: >- Records the date when the applicant was granted a supplemental waiver. supplementalWaiverSignature: type: string description: >- Stores the applicant's signature for any additional waivers or agreements beyond the primary application. waiverDate: anyOf: - type: string - type: string description: >- Represents the date on which an applicant was granted a waiver or exemption. waiverSignature: type: string description: >- Contains the signature of the applicant agreeing to the terms and conditions outlined in the waiver. required: - aliasNameFirst - aliasNameLast - applicationDate - currentAddressYearStart - dropResume - dropWaiver - font - georgia_race - id - id_address1 - id_address2 - id_birthdate - id_cardRevisonDate - id_city - id_classificationCode - id_complianceType - id_country - id_countryCode - id_documentType - id_endorsementCode - id_endorsementCodeDescription - id_expirationDate - id_firstName - id_fullName - id_gender - id_hazmatExpDate - id_idScanErrorMessage - id_idScanSuccess - id_idScanTimestamp - id_IIN - id_issueDate - id_issuedBy - id_jurisdictionCode - id_lastName - id_licenseNumber - id_limitedDurationDocument - id_middleName - id_namePrefix - id_nameSuffix - id_postalBox - id_postalCode - id_requestId - id_restrictionCode - id_restrictionCodeDescription - id_vehicleClassCode - id_vehicleClassCodeDescription - id_veteran - info - isDropDriverLicense - isDropDriverLicenseBack - isDropResume - isDropSelfie - isNoIdScan - PersonId - priorAddressCity - priorAddressCounty - priorAddressState - priorAddressStreetPrimary - priorAddressStreetSecondary - priorAddressYearEnd - priorAddressYearStart - priorAddressZip - ssn - supplementalWaiverDate - supplementalWaiverSignature - waiverDate - waiverSignature components: parameters: id: schema: $ref: '#/components/schemas/id' required: true name: id in: path schemas: id: type: number description: The ID of the entity for this request. example: 5 ````