Bearer token returned by the authorization endpoint; used on subsequent requests via Authorization: Bearer <token>. Tokens are valid for ~60 minutes (expires_in: 3600) and must be re-obtained when expired.
Country‑specific company ID types listed in Key Reference Data.
API is an acronym for Application Programming Interface. An API is a standard non-graphical interface that makes an application’s functionality available to other applications over a network. The two databases connected by an API can share data based on predefined permissions. API work like digital building blocks, datas retrieved allow you to build bespoke risk management process within your own connected application.
The portal area listing available Allianz Trade APIs through (login required to view details)
A credential you generate on the portal to obtain an OAuth2 access token; sent to the /oauth2/authorize endpoint to receive an access_token.
A call made by your application to an Allianz Trade API endpoint to perform an action or retrieve data.
All APIs are protected via OAuth2; obtain a token by POSTing your API key to the authorization endpoint (test/prod), then call APIs with the Bearer token.
Transactions or services between two businesses rather than between a business and individual customers.
The counterpart who will be indemnified by Allianz Trade in case of justified performance default of Allianz Trade contractor (our client).
Guarantee pledges by Allianz Trade to protect your contract counterpart against a performance failure risk from your company.
An API call to request the issuance of a surety bond for a specific contract or project.
Short codes used to identify Allianz Trade offices worldwide (e.g., SFAC = France, HERM = Germany); retrieved via the Reference Data API.
A company or business partner for whom credit coverage is requested or evaluated.
The API-enabled process of assessing a new buyer’s creditworthiness when they register or make their first purchase.
Your HTTPS endpoint provided (base64-encoded string in headers for some flows) so Allianz Trade can notify you when an async job completes; can include TTL and options for extended (functional) notifications. Domain whitelisting applies.
Real-time evaluation of transaction data to detect high-risk or suspicious activity.
Used in search APIs, e.g. pageSize, to limit returned results.
Feature in Payment Overdues API to report partial settlement.
Reports overdue invoices and requests extensions or rescheduling.
The result of the API-based risk decisioning that determines the payment period offered to a buyer (e.g., net 30, net 60).
Your agreement with Allianz Trade outlining what’s covered, under what conditions, and to what extent.
Assessment tools or API feeds that give visibility into overall risk across all your buyers.
Ready‑to-use API testing collections provided by Allianz Trade.
Fraud‑checking step during E‑commerce checkout.
The party whose obligations are being guaranteed under a surety bond (often your customer).
The live environment where your application uses real data and interacts with actual Allianz Trade services.
An underwriting proposal generated during checkout before activating a transaction cover.
Requestor makes a quotation request before activating or rejecting the guarantee.
A restriction on how many API calls you can make in a certain period to maintain system stability.
The ability to instantly approve or decline a buyer or transaction using Allianz Trade’s risk intelligence.
Provides country codes, identifier types, business unit codes, etc.
A token that allows your app to request a new access token without requiring user login again.
Indicates which type of cover you’re requesting in V3 (e.g., Primary, CAP, GradePolicyCoverBasic).
Allianz Trade Surety client or the contractor.
REST (Representational State Transfer) is a set of web API architecture principles, or constraints, (not a protocol or a standard), that dictate how web service applications communicate over the internet. For this purpose, REST API (also known as a RESTful API) uses the HTTP protocol between client and host server at a predefined set of URLs.
Guidelines for how your application should handle failed API calls, including retry attempts.
An internal Allianz Trade rating that evaluates a company’s financial stability and creditworthiness.
A secure test environment where you can simulate API calls without impacting real data or live services.
SAP extension allowing Allianz Trade data (grades, risk info, limits) to be used inside SAP workflows.
Macro-level risk indicators included in Grade Check responses
Codes representing business outcome (e.g., rejected, cancelled, already agreed).
.
A financial guarantee provided by Allianz Trade that ensures contractual or regulatory obligations are fulfilled.
Webhook informing you a job is technically processed (not the final decision).
Temporary limiting of API request rates when the limit is exceeded.
Duration (in hours) that your webhook subscription is valid.
A commercial action that results in an invoice. In E‑commerce, each transaction may be insured.
A unique identifier assigned to each API call or process for tracking and troubleshooting.
It is a phase in the software development lifecycle where the end users test the system in a real-world environment to ensure it meets their requirements and functions correctly before it goes live. The primary goal of UAT is to validate the end-to-end business flow and confirm that the software solution is ready for deployment.
It refers to the process and tools used to plan, execute, and manage UAT activities. UATM involves coordinating the testing efforts, tracking progress, managing test cases, reporting defects, and ensuring that the testing is completed successfully. Effective UATM helps streamline the UAT process, ensuring that all user requirements are thoroughly tested and any issues are addressed before the software is released.
The financial and legal factors Allianz Trade evaluates before approving a bond or credit coverage.
A company for which no CompanyId exists yet; details must be provided manually in cover requests.
A mechanism that allows one system to send real-time data to another system as soon as an event occurs. It is essentially a user-defined HTTP callback that is triggered by specific events, enabling automated communication between applications without the need for constant polling. Webhooks are commonly used to send notifications or updates from one application to another, facilitating seamless integration and data exchange.
Your domain/IP must be approved before receiving webhooks.