Integrating with the Castellum.AI API

Integrating the Castellum.AI REST API into your product should take less than a week and the resources of only one developer. We recommend taking the following steps:

1. Create a free Platform account to test all of our watchlist data here.
2. Review our API documentation here.
3. Access our API sandbox and receive a client ID and secret. The API sandbox has a limited data set and should be used for integration testing and stability testing.
4. Authorize your API sandbox credentials using an external testing environment (e.g. postman). Below is a sample request to start making API sandbox calls. 
   1. The Sandbox Platform is available as a UI tool to accompany the API sandbox. The Sandbox Platform data mirrors the data in the API sandbox and can be used for comparisons and testing.
5. Only paying users receive access to the Production API, which contains global risk data updated every 5 minutes.

Note: Once issued, an access token should be reused until it expires. Access token requests are rate limited and too many requests will result in a 429 response. Access tokens expire after 24 hours.

API SANDBOX EXAMPLE REQUEST

1. Request an access token:

curl --request POST \
--url 'https://sandbox-castellum-ai.us.auth0.com/oauth/token' \
--header 'content-type: application/json' \
--data '{"client_id": "_YOUR_CLIENT_ID_", "client_secret": "_YOUR_CLIENT_SECRET_", "audience": "https://grpc-server.castellum.ai", "grant_type": "client_credentials"}'

curl --request POST \
--url https://api.sandbox.castellum.ai \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer _YOUR_TOKEN_' \
--data '{"query": {"min_score": 0.85, "name": "Qasem Soleimani", "list_sources": [{"name": "US OFAC SDN"}]}}'

curl --request POST \
--url 'https://auth.castellum.ai/oauth/token' \
--header 'content-type: application/json' \
--data '{"client_id": "_YOUR_CLIENT_ID_", "client_secret": "_YOUR_CLIENT_SECRET_", "audience": "https://grpc-server.castellum.ai", "grant_type": "client_credentials"}'

curl --request POST \
--url https://api.castellum.ai \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer _YOUR_TOKEN_' \
--data '{"query": {"min_score": 0.85,"name": "Qasem Soleimani", "list_sources": [{"name": "US OFAC SDN"}]}}'