Developers

Build something for America.

Getting Started

To get started building a MyUSA App, you'll need to do the following:

Create an account

Go to /sign_up and create a MyUSA Account. If you have not been approved for the private beta, but would like to develop something, contact us with details.

Register your application

Register a new application with MyUSA, and make sure to save your MyUSA Client ID and MyUSA Client Secret; you'll need these to authenticate your application with MyUSA.

When you create a new application, the app will be 'sandboxed.' This means only MyUSA users that have the same email address as you have on your account will be able to authorize the application. Once your app is mature, you can apply to have it made public for all MyUSA users to utilize. Contact us if you think your app is ready for prime time.

Build something awesome!

Learn about the MyUSA Citizen API (see below) and build something that makes the lives of all Americans better.

Check out some apps we built:

MyUSA Citizen API

The MyUSA Citizen API is how MyUSA Apps interact with MyUSA Accounts. Let's take a look at the features that you can integrate into your application using the MyUSA Citizen API.

For more detailed information on the MyUSA Citizen API, browse the MyUSA Citizen API documentation.

Profile

MyUSA Apps can access a MyUSA Account user's profile information. Information that is available includes: name, address, contact information and some basic demographic information (married, veteran status, student).

If your MyUSA App needs access to a user's profile, make sure to select the 'profile' option when registering your application.

Tasks

Need to help a MyUSA user through a complex set of steps to accomplish something? The Tasks API is for you! Using the Tasks API, you can create a task with a list of task items for a user. Tasks that your app creates will show up in their MyUSA Account. You can also go back and retrieve tasks that your app created for a user, so you can integrate them in your app.

If your MyUSA App needs to assign tasks to users, make sure to select the 'tasks' option when registering your application.

Notifications

MyUSA Apps can notify MyUSA users with new information using the Notifications API. MyUSA users will be alerted both via the MyUSA Account and email that they have a new notification from your app.

If your MyUSA App needs to notify users with new information, make sure to select the 'notifications' option when registering your application.

More coming soon!

We have more API features coming soon. Check back here, or on the MyUSA blog for updates.

Authentication

In order to get access to the MyUSA Citizen API, your application will need to authenticate itself with MyUSA. MyUSA uses the OAuth 2.0 protocol for authentication and authorization of requests. When registering your application with MyUSA, make sure to save your OAuth client and secret ids, as you will need them when authorizing with MyUSA.

Here's some resources to help you get started with OAuth 2.0 and using the MyUSA Citizen API: