Documentation
Getting Started
This guide provides all the essential steps to begin integrating with our APIs—from registration to making your first successful call. Whether you're exploring capabilities, running tests, or preparing for go-live, this page is your go-to resource for quickly getting up and running with Allianz Trade APIs.
Account Creation
- Click to Register.
- Complete the registration form. Please remember to use accessible email as the password link will be emailed.
- After the registration form is submitted, an activation email will be sent out within 1 to 3 business days.
- Open the activation email click on link to set your password.
- Once you've set your password, log in to the Developer Portal to finalize your account creation.
Haven't received the activation email?
Check your spam or junk folder. Still missing? Check out our FAQ page.
Discover Our Products
Take a moment to review what’s available before diving into your integration.
Browse our APIs
- API Overview - learn the purpose and capabilities of each API in detail.
- Available Endpoints - Get a detailed list of the endpoints and their specific functions.
- Requests & Response Samples - review examples to grasp how the APIs operate.
Review Use Cases
Explore practical scenarios to see how our APIs enhance your workflows, and use integration guides with step-by-step tutorials for a seamless setup.
Navigating Environments
Allianz Trade provides three purpose-built environments to support every phase of your integration lifecycle:
Name | Description | How to get access | Base URL |
|---|---|---|---|
| Sandbox | Mock environment for testing without sensitive data | Start exploring our APIs by importing our mock collection into Postman. No permissions required. | See details here |
| Acceptance (UAT) | User Acceptance Testing environment for validating integrations before production deployment. | Request access to our test environment through your dashboard. | https://api-services.uat.1placedessaisons.com/uatm |
| Production | Live production environment for real transactions and data. | Request access to our production environment through your dashboard. | https://api.allianz-trade.com |
Each environment is designed for a specific development milestone, ensuring your application is tested, stable, and ready for deployment.
Request Access
All Allianz Trade APIs require an API key and an access token. To start, navigate to your dashboard and follow the steps below.
Generate API key
Under Environment & API keys click on 'Manage API keys' button to request access to our test environment. Once our environment set up is complete, you will be notified via email to navigate back to your dashboard to generate your API key. Same process will follow for production.