Updated SAVE ICA v38 Draft is Now Available for Registered Web Services Agencies
We appreciate the valuable feedback that user agencies offered at listening sessions last spring, and as a result, we updated the draft SAVE Interface Control Agreement (ICA) v38. This link will redirect users to log in to view the updated draft. Registered Web services agencies can use this draft for planning purposes and to familiarize developers but should be aware this draft may still be modified. The ICA does not impact registered agencies that solely use the SAVE web browser.
Note: Agencies are not able to test against the draft ICA or have the available Application Programming Interface (API) endpoints until the final ICA v38 is published, currently scheduled for spring 2025.
The updates made to the draft ICA v38 include:
- Added provenance information (including client_user_field) to authentication token description;
- Added description of Request IDs;
- Updated Get Case response to include status information as well as Resolution data;
- Added create Duplicate Case endpoint for creating a case flagged as a duplicate;
- Added Acknowledge Resolution endpoint for acknowledging receipt of a resolution;
- Added Return Resolution in a case creation response if it is available;
- Added details to case closure response definition;
- Allowed for multiple status responses in resolution data;
- Added Additional Verification Reason fields to case escalation;
- Added endpoint to get available benefit code;
- Added endpoint to get available country code;
- Added length constraints and examples to all case creation fields;
- Adjusted error example to be more realistic. Example scenario is a validation error, so make the error code 400;
- Adjusted the case details result to include a list of resolutions, and a timestamp of the resolution;
- Adjusted the case details result to include the initial case creation request data;
- Moved entryDate to be per Status instead of per resolution; and
- Added the description to the foreignPassportNumber field indicating that it also requires a US issued immigration identifier.
For agency-specific questions, please contact your agency directly. If your agency has questions regarding the updated draft, please email savemodsupport@uscis.dhs.gov.