Skip to main content

Get Started

Perform your first compliance check with the KYC API in three simple steps.

Step 1: Get Your API Credentials

Contact your account administrator to obtain API credentials. You’ll receive either:
Temporary tokens issued through your authentication provider (Cognito). Ideal for web applications and mobile apps.Validity: Typically 1 hour
Best for: User-facing applications, frontend integrations
Permanent credentials for machine-to-machine integrations.Format: sk_xxxxxxxxxxxxxxxx
Best for: Backend services, automated integrations, scheduled jobs
Store API keys securely in environment variables or secrets manager.

Step 2: Choose Your Environment

Select the appropriate environment for your needs:
Start with Staging for development and testing. Move to Production when you’re ready to go live.

Step 3: Make Your First Request

Check an entity against the OFAC sanctions list:
No match found - Entity is clear from OFAC sanctions.
Match found - Entity appears on OFAC sanctions list. Review required.

Common Use Cases

Now that you’ve made your first request, explore common integration patterns:

Check Multiple Lists

Screen against OFAC, UN, and EU lists simultaneously.

Crypto Wallet Screening

Validate cryptocurrency wallet addresses against sanctions.

Adverse Media Checks

AI-powered screening for negative news and risk factors.

Ongoing Monitoring

Set up automated watchlist monitoring with alerts.

Next Steps

1

Review Authentication

Learn about JWT tokens vs API keys and permission requirements.
2

Explore Endpoints

Browse the full API reference for all available features.
3

Understand Rate Limits

Review rate limiting and WAF protection to optimize your integration.
4

Export Results

Generate PDF reports for compliance documentation.
Production Checklist
  • ✅ Use Production API keys (not Staging keys)
  • ✅ Implement proper error handling
  • ✅ Store credentials securely
  • ✅ Monitor usage metrics
  • ✅ Set up webhook endpoints for watchlist alerts