The USPTO Open Data Portal (ODP) connects to Caddi with an API key that you get from the Manage API Key page on the Open Data Portal.
Before you start
You'll need:
A USPTO.gov account
An ID.me account that is verified and linked to your USPTO.gov account. The USPTO requires this before it will issue an API key. Linking is a one-time step, and you can start it from the Open Data Portal in Step 1.
These fields filled in on your USPTO.gov profile: Job Title, Organization Name, Organization Type, and Intended Use. The USPTO deactivates API keys for accounts missing them.
Owner or Admin access to your Caddi organization
Step 1: Get your API key from the Open Data Portal
Go to Manage API Key on the Open Data Portal and sign in with your USPTO.gov account.
If your USPTO.gov account is not yet verified with ID.me, follow the on-screen steps to verify it. This links the two accounts.
On the final page, click the button to request API key access. Your API key is shown.
Copy the key.
Each USPTO.gov account has one API key.
Do not send this key by email, chat, or a support ticket. Paste it straight into Caddi in Step 2, or keep it in a password manager until you do.
Step 2: Add the key in Caddi
In Caddi, open Settings, then Integrations.
Under Connectors you can configure, find USPTO - Custom ODP API Key and click Configure.
Paste the key into API Key.
Click Save Configuration.
For multiple users to setup their API keys, reach out to Caddi support for assistance.
Sources
Getting Started — USPTO Open Data Portal
FAQs — USPTO Open Data Portal
Manage API Key — USPTO Open Data Portal
API Key video transcript — USPTO Open Data Portal
