FAQs
General
USCIS APIs are for software development organizations incorporated within the United States, who can comply with our Terms of Use and offer Section 508 compliant apps and websites with a suitable privacy policy.
You do not need to have customers, but you will need to provide documentation of your policies. USCIS will complete due diligence to validate that your policies are compliant.
If you market your software to external users, you must have a public website where these policies are posted for USCIS to complete due diligence.
All members of your company/organization who will require access to your API keys must create an account to be able to access our APIs. Sharing login credentials is prohibited and violates our Terms of Use.
More details on sharing your API keys available in API Keys Section of this FAQ.
Anyone from your organization can create a team. However, you should designate 1 person to reduce creating multiple teams.
If your company already has a team, see more in Developer Teams and Developer Team Apps on how to invite other team members to join the team.
Currently USCIS is offering RESTful APIs available in the following environments
- Sandbox : for external integration testing in a staging environment.
- Production: for external use, access to prod data granted when you pass your demo*
*for more information on how to request access, see Production Access Process
View our available APIs by visiting here.
The architecture is a “pull” model—we provide REST endpoints. You must make a request to our APIs to get information.
REST is simple, lightweight, scalable, and maps very well to represent and exposing data.
USCIS will only have access to the data you submit, which will be sent to the relevant system and stored there according to our security and privacy policies.
Our APIs only support individual submissions, but your client-facing side can support either batch or individual submissions. Just make sure you use the correct ID for each submission to ensure proper processing. Please also review our API Rate Limits and Throttling to avoid any errors.
API Keys
Developer Team Apps are associated to your API keys (aka Client Credentials) and identifies your application to USCIS. Once your Developer Team creates a Developer Team App, you should be able to:
- Retrieve Client Credentials (Client ID and Client Secret)
- Request Access to Available API Products
No. Sharing your login credentials or API keys is a violation of our Terms of Use. Anyone who requires access to your API keys must:
Register for an account
Accept the invitation to your Developer Team
API keys are a unique pair of client credentials (Client ID and Client Secret). These keys are used to request an Oauth 2.0 access token. When validated, a token is granted and must be presented in your authorization headers when making an API request from your front end application to any USCIS APIs
Your API keys are revealed to you when you create a Developer Team App or accept an invitation to view an existing Developer Team App.
Your Access Token is granted when you successfully authorize your Developer Term App using OAuth 2.0 Authentication. By providing your Client Credentials, you can request for an Access Token by calling our OAuth Endpoint.
For additional information please see "How to Get Access Tokens with Client Credentials".
The Try It Tool is a quick way to test the Sandbox APIs. You must have API keys approved to access the Sandbox API Product in order for this to work.
For more details please see: "How to test an API in Sandbox - 'Try It Authorize' Feature"
Production API keys are granted to developers who successfully pass and meet our demo requirements. During this review, USCIS will evaluate your system’s back-end architecture.
USCIS will accept requests for additional keys only if the back-end architecture of the new application operates independently from other implementations previously granted production access. These requests are subject to our normal demo requirements for production access.
Demo
The demo evaluates more than product functionality. Your team should be prepared to explain the application’s technical architecture, code, security approach, and compliance with the USCIS Terms of Use. Find out more about what we need to see during your demo on our Schedule and Prepare for Demo page.
Schedule a demo only when your application is functional, available to demonstrate, and your team is prepared to answer technical questions about the application’s code and architecture. Please do not book a session before you are ready. To see our full requirements, visit the Schedule and Prepare for Demo page.
Demo sessions vary depending on API requirements. You will receive a booking link with the correct time allotted. Sessions will not be extended if you are unprepared or unfamiliar with the technical design of your application.
- Read the demo checklist in full.
- Confirm the team is ready to be evaluated against each item on the checklist.
- Ensure that your app meets USCIS' basic demo criteria.
- Audit any SI-generated or agent-assisted code.
Yes, but your team is responsible for reviewing, validating and understanding all SI-generated or SI-assisted work. Team members should be able to explain how the code works, not just how to run it.
You can learn more about how should attend a demo on our Schedule and Prepare for Demo page. Someone who can explain the application’s architecture, code, security, and functionality must attend. Attendees should be able to answer technical questions. Using a chatbot or getting information from someone who is not on the call are not allowed.
The session will proceed within the scheduled time, and additional time will not be provided for teams that are unprepared, unfamiliar with their application, or unable to address expected technical questions. Teams that cannot demonstrate compliance with all required criteria during the allotted time may be scheduled for a subsequent re-demonstration. USCIS may end the session at any point time if we determine the application will not meet the criteria for a passing result. Completion of the demonstration does not constitute a passing determination.