Schedule and Prepare for Demo
Our Demo Availability
Demos are available on a first come, first served basis. Demo appointments are available every Tuesday and Wednesday from 1:00 PM EST - 2:00 PM EST, pending USCIS availability.
- Case Status API: 30 mins
- FOIA Request and Status API: 60 mins
A scheduler link will be emailed to book your demo appointment. Expand each section below to review the additional criteria.
Your development team must be available during the session to conduct the demonstration and answer any questions.
You must provide a complete (from start to finish) demonstration of your application. Your demonstration must cover the following scenarios that display how your application is using the APIs.
During your demonstration session, we will rate the following with either Pass or Fail
| Category | Description |
|---|---|
| Whether a user can easily enter the required information in your application throughout the user interface. | Your front end application is clear on what it is asking and provides helper information to the user to complete a specific task. Examples, validations and placeholders are encouraged. |
| Whether the user's completed application successfully converts to a JSON payload. | The User Interface successfully converts the fields into a JSON Payload on the backend and structures the payload to match the APIs definition. |
| Whether the application successfully authenticated to our API using OAuth 2.0. | Utilization of Client Credentials to issue an access token is required to authorize all USCIS Torch APIs. We would like to see how you implemented Oauth 2.0 in your application. |
| Whether the USCIS API HTTPS response was successfully sent back and presented in the application. | Success and Error Response handling is visible in the User Interface (front end application). Logging on the backend may be acceptable. We need to validate you are receiving response messages to display accurate messages to users. |
| Whether your application tracks case status from your application. | Successful retrieval of Case Status Updates from the API are visible and presented clearly to the users. |
| Whether a user was able to successfully upload an encoded file as outlined in the documentation.* | Successful at attaching documentation that meets the file type requirements. |
*applicable to FOIA Request and Status API only
Your system must respond and recover from errors that may occur during execution. During the demo session, we must see how your application handles all HTTPS responses passed from our APIs. Our APIs will throw error messages in the JSON format below, as described in RFC-9457 Problem Details for HTTPS APIs .
The error.message must be displayed on the front or back end of your application. See more in Demo Details
Error Format
{ "errors": [{ "code": "ERROR_UNIQUE_CODE", "message": "ERROR_MESSAGE", "category" : "SHORT_DESCRIPTION/ERROR_CATEGORY", "reference" : "API_DOCUMENTATION_LINK", "status" : "HTTP_STATUS_CODE", "traceId" : "UUID" }] }The primary contact on the attestation must attend. The primary contact should be an individual who can bind your organization and answer questions about your business. You must also include an individual who will lead the end-to-end live technical demonstration of your API implementation and can answer any technical questions must also attend. These may be the same person.
We also recommend people with the following knowledge or expertise attend to ensure your demo runs smoothly:
- Business Decision Makers: Someone who can make business-level IT decisions.
- Software Developers: A Technical lead or developer who is very familiar with USCIS APIs and your application who is able to address findings during the demo.
- Interpreter: If your team does not speak English to a business fluency, we recommend including an individual who can translate technical terms into English. USCIS does not provide translation or interpreter services for API Torch support.
Please review our agenda to prepare your live technical end-to-end demonstration of your application's use of our APIs.
- Welcome & Introductions
- Name, Title, Company Name, Application Name
- Provide a brief introduction of your application and its use case (optional)
- Demo Expectations & Requirements
- Technical end-to-end demonstration of your application's use of our API(s).
- Demonstrate HTTPS response handling of ALL documented response codes in the APIs documentation page.
- Live user flows that invoke the API.
- Multiple test cases
- Use of your staging environment, ensuring that all PII is removed.
- Feedback
- We may ask you to repeat specific process flows during the session
- We may request answers to questions and present and follow up questions
- We may engage in a feedback session with questions and answers.
PASS
Once you have completed your demo, we will review the data and session results to ensure that your application has accurately passed through the requested API. Results will be emailed to you within 2-business days.
FAIL
We offer re-demos on a first come, first served “office hours” format. We will email you a scheduler link to reserve a time for those who do not pass their first attempt.
- Re-Demo Office Hours
- The expectations and requirements for re-demos are as follows:
- You must RSVP to attend.
- You are allowed 15 minutes to demo your application.
- Your re-demo must demonstrate that you are able to meet the criteria you missed during your original demo.
- You will be emailed the results of your re-demo within 2 business days.
- The expectations and requirements for re-demos are as follows: