### Document API Source: https://success.mitratech.com/INSZoom/Help_Articles/Support/Zoom_APIs Get Client/Foreign National’s or Case Document download URL. ```APIDOC ## GET api/v1.0/Documents/GetDocumentDownloadURL/{documentId} ### Description Retrieves the download URL for a specific document. ### Method GET ### Endpoint api/v1.0/Documents/GetDocumentDownloadURL/{documentId} ### Parameters #### Path Parameters - **documentId** (string) - Required - The ID of the document. ``` -------------------------------- ### Auth API Source: https://success.mitratech.com/INSZoom/Help_Articles/Support/Zoom_APIs Establishes API authentication. ```APIDOC ## POST api/v1.0/Auth ### Description Establishes API authentication. ### Method POST ### Endpoint api/v1.0/Auth ``` -------------------------------- ### Client and Case API Enhancements Source: https://success.mitratech.com/INSZoom/Product_Updates_And_Form_Updates/What%27s_New_Current_Release/Product_Updates_2024/Product_Updates_-_April_2024 Users subscribed to the Zoom API can now include 'Current Arrival/Departure Info', 'Address', and 'Proposed Job Info' when creating or updating Clients (FN) or Cases via the API. These enhancements provide more detailed entity management capabilities. ```APIDOC ## Client and Case API Enhancements ### Description This API update allows for the inclusion of detailed 'Current Arrival/Departure Info', 'Address', and 'Proposed Job Info' when managing Client (FN) or Case entities through the Zoom API. This enables richer data management for immigration and employment-related information. ### Method POST/PUT (Implied by 'creating/updating') ### Endpoint Client API Endpoint / Case API Endpoint ### Parameters #### Request Body - Address Details - **AddressType** (string) - Optional - Type of address (e.g., Main Personal Address). - **IsMainAddress** (boolean) - Optional - Indicates if this is the primary address. - **Fax** (string) - Optional - Fax number. - **MobileNumber** (string) - Optional - Mobile phone number. - **PhoneNumber1** (string) - Optional - Primary phone number. - **PhoneNumber2** (string) - Optional - Secondary phone number. - **Country** (string) - Optional - Country of the address. - **City** (string) - Optional - City or town of the address. - **HomeCountry** (string) - Optional - Home or origin country. - **StreetNumber** (string) - Optional - Street number. - **StreetName** (string) - Optional - Street name. - **Apt/Ste/Flr** (string) - Optional - Apartment, suite, or floor designation. - **Apt/Ste/FlrNumber** (string) - Optional - Number for the apartment, suite, or floor. - **State** (string) - Optional - State or province. - **ZipCode** (string) - Optional - Zip or postal code. #### Request Body - Current Arrival/Departure Info - **I-94Number** (string) - Optional - The I-94 number. - **ImmigrationStatusonI-94** (string) - Optional - The immigration status as recorded on the I-94. - **PlaceofArrival** (string) - Optional - The place where the individual arrived. - **StateofArrival** (string) - Optional - The state of arrival. - **DateofArrival** (date) - Optional - The date of arrival. - **I-94ValidFrom** (date) - Optional - The date from which the I-94 is valid. - **DateofExpiration** (date) - Optional - The expiration date of the I-94. - **DateofRenewal** (date) - Optional - The date of the last renewal. - **ArrivalApprovalisValidtillDurationofStatus** (boolean) - Optional - Indicates if the arrival approval is valid until the duration of the status. #### Request Body - Proposed Job Info - **JobTitle** (string) - Optional - The title of the proposed job. - **InternalJobTitle** (string) - Optional - The internal job title. - **DOTCode** (string) - Optional - The Dictionary of Occupational Titles (DOT) code. - **Country** (string) - Optional - The country where the job is located. - **StreetNumber** (string) - Optional - Street number of the job location. - **StreetName** (string) - Optional - Street name of the job location. - **Apt/Ste/Flr** (string) - Optional - Apartment, suite, or floor designation for the job location. - **Apt/Ste/FlrNumber** (string) - Optional - Number for the apartment, suite, or floor at the job location. - **CityTown** (string) - Optional - City or town of the job location. - **State** (string) - Optional - State or province of the job location. - **ZipCode** (string) - Optional - Zip or postal code of the job location. - **Wages/SalaryOffered** (string) - Optional - The offered wages or salary for the job. ### Request Example ```json { "client": { "addressDetails": { "StreetName": "123 Main St", "City": "Anytown", "Country": "USA" }, "currentArrivalDepartureInfo": { "I-94Number": "1234567890", "DateofArrival": "2023-01-15" }, "proposedJobInfo": { "JobTitle": "Software Engineer", "Wages/SalaryOffered": "100000" } } } ``` ### Response #### Success Response (200) - **Success**: Indicates the operation was successful. - **Message**: A confirmation message detailing the update. #### Response Example ```json { "success": true, "message": "Client details updated successfully." } ``` ```