Support

Need help? We've got you.

Browse Support topics or search for exactly what you need.

Authentication Get started Cover Guidelines
Support by Topic
API Design
API Design

Model resources, version APIs, handle errors.

Functional
Functional

What each API does and common flows.

bolt
Tips & Optimization

Best practices to optimize your API integrations.

Portal settings
Portal settings

Get started, account settings and others.

Cover V2 to V3 Migration
Cover V2 to V3 Migration

Upgrade to Cover V3 for Better Performance and Long‑Term Reliability

SOAP to REST Migration
SOAP to REST Migration

Move to REST for a Simpler, Modern API Experience.

Calendar Outline
Maintenance Calendars

Planning for system outages.

Security
Security

Security, authentication, and access management.

Top 5 most asked questions

Allianz Trade APIs enable you to automate and streamline a wide range of workflows across our solutions.
This includes trade credit insurance processes such as credit limit requests, monitoring, and alerts — as well as integration with Allianz Trade Pay and Surety products directly inside your ERP or CRM.
Our API catalog and step‑by‑step tutorials help you integrate each product efficiently.

To get started, explore the Developer Portal (Products, API Catalog) and follow the Get Started guide to make your first API calls.

Steps:

1. Create an account or log in to the Developer Portal.

2. Once logged in, open your account menu (top‑right corner) and select "Environment & API Keys". From there, you can request authorization to access our backend services.

3.After your access is approved and you’ve completed your tests, request your production API keys.

 
Note:
These steps are also explained in the Get Started guide, which highlights that you must generate your own private API key before making OAuth requests.
To obtain an OAuth2 access token, you must call the Allianz Trade Identity Provider (IDP) POST /oauth2/authorize endpoint using your private API key.

 

1. Prepare the Request

Method: POST
Headers:

Content-Type: application/json

URL (Test environment):

https://api-services.uat.1placedessaisons.com/uatm/v1/idp/oauth2/authorize

URL (Production environment):

https://api.allianz-trade.com/v1/idp/oauth2/authorize

Body:

{
	"apiKey": "YOUR_API_KEY"
}
 

2. Handle the Response

A successful request returns a JSON object such as:

{
    "access_token": "YOUR_ACCESS_TOKEN",
    "token_type": "Bearer",
    "expires_in": 3600
}
 
Tokens are valid for 60 minutes.
Tokens cannot be refreshed.
→ You must request a new token once the previous one expires.

 

Learn more

For full details about authentication, environments, and API keys, refer to the guide
Use the Company Search API to look up a company and retrieve its companyId.
 

Endpoints

Test environment:

POST https://api-services.uat.1placedessaisons.com/search/uatm-v2/companies/advancedSearch

Production environment:

POST https://api.allianz-trade.com/search/v2/companies/advancedSearch
 

Request

Headers

Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

Body (basic request example)

{
    "companyName": "SOME_COMPANY_NAME",
    "countryCode": "FR",
    "pageSize": 1
}
This basic request returns the company matching your criteria, including its companyId.

 

Additional Information

  • The API supports additional search parameters (address fields, identifiers, etc.).
    Refer to the Company Search documentation in the Get Started guide.
  • For country codes and other key reference data (such as country‑specific identifiers), see Key Reference Data to keep your filters accurate and consistent.
  • Always include a country code when possible — this reduces false positives and improves performance.
  • Use pageSize to control response size when retrieving multiple candidates.
Webhook notifications let you avoid polling job IDs repeatedly. Instead, Allianz Trade pushes updates to your system when processing is complete. There are two types of notifications you may receive:
 

1. Technical Notification

Trigger: Sent as soon as the request is technically processed in Allianz Trade systems.

What it confirms:

  • The object (e.g., a cover) has been technically created or updated.
  • Processing has finished from a system/technical perspective.

Payload contains:

  • The cover (technical object).

When you will receive it:

  • Always, as long as you provide a valid webhook configuration.

 

2. Functional Notification

Prerequisite:
You must set extendedNotification: true

Trigger: Sent after the technical notification, when a business decision becomes available (e.g., Accepted, Refused).

Functional notifications are only sent if:

  • The request had a pending decision, and
  • A business outcome becomes available later.

Payload contains:

  • The coverRequest.

Why they exist:

Because technical creation often happens immediately, while business decisions may take more time.

 

Enabling Webhooks

To receive webhook notifications, you must configure callback settings in the request headers.
 

Required fields (Base64‑encoded JSON object):

  • callbackUrl — Your HTTPS endpoint to receive notifications
  • timeToLive — Validity window (in hours) for the callback
  • extendedNotification (optional) — Set to true to get functional notifications in addition to technical ones

Important:
The callback payload must be stringified, Base64‑encoded, and your endpoint must support HTTPS.

 

Domain/IP Whitelisting

Allianz Trade must whitelist your domain or IP address before webhook notifications can be delivered to your endpoint.

Without whitelisting, callbacks will not be sent.

 

Header Examples (Before Base64 Encoding)

A. Technical notifications only

{
"callbackUrl": "https://client.example.com/webhook",
"timeToLive": 24
}

B. Technical + functional notifications

{
"callbackUrl": "https://client.example.com/webhook",
"timeToLive": 24,
"extendedNotification": true
}

Encode the JSON above as a Base64 string and include it in the header according to the API specification.