Skip to main content

Documentation

Glossary

 


 

A

 

Access token (OAuth2)

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. 

 

ACN / National Identifiers

Country‑specific company ID types listed in Key Reference Data.

 

API (Application Programming Interface)

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.

 

API Catalogue

The portal area listing available Allianz Trade APIs through (login required to view details)

 

API key

A credential you generate on the portal to obtain an OAuth2 access token; sent to the /oauth2/authorize endpoint to receive an access_token.

 

API Request

A call made by your application to an Allianz Trade API endpoint to perform an action or retrieve data.

 

API Response

is what the server sends back after you ask it for something. It tells you if the request worked and gives you the result.

 

Authentication (OAuth2)

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.

 


 

B

 

B2B (Business to Business)

Transactions or services between two businesses rather than between a business and individual customers.

 

Bearer Token

OAuth2 token placed in Authorization: Bearer <token>, valid for 1 hour.

 

Beneficiary

The counterpart who will be indemnified by Allianz Trade in case of justified performance default of Allianz Trade contractor (our client).

 

Bonds

Guarantee pledges by Allianz Trade to protect your contract counterpart against a performance failure risk from your company.

 

Bond Request

An API call to request the issuance of a surety bond for a specific contract or project.

 

Business Unit Code (BU Code)

Short codes used to identify Allianz Trade offices worldwide (e.g., SFAC = France, HERM = Germany); retrieved via the Reference Data API.

 

Buyer

A company or business partner for whom credit coverage is requested or evaluated.

 

Buyer Onboarding

The API-enabled process of assessing a new buyer’s creditworthiness when they register or make their first purchase.

 


 

C

 

Callback URL

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.

 

CAP / CAP Plus

Types of cover requests (Primary, CAP, CAPPlus) represented via requestTypeCode in V3.
 

Claims API

API that lets you view or create insurance claims.

 

Client ID

The URL where the API sends event notifications or webhook updates.
 

CompanyId

The unique ID for a company inside Allianz Trade’s systems. You get it using Company Search.

 

Company Search API

API where you search for companies by name, country, etc., to get their CompanyId.
 

Cover API (V3)

Unified endpoint to request credit limits using requestTypeCode.
 

 

D

 

Decision (Functional)

The final business outcome of a cover request (accepted/refused)
 

Discretionary Credit Limit (DCL)

A predefined credit threshold allowing buyers to transact without underwritten credit limits, typically for low-risk customers.
 

Decline Reason Code

A specific explanation returned when an API request is denied (e.g., insufficient data, unacceptable risk level).
 

Discretionary Limit

Technical Guides and reference materials that explain how to use the API endpoints.
 

Document Delivery

Sending the final signed bond, policy, or decision document (PDF or physical) to the relevant party.
 

 

E

 

E-commerce (Allianz Trade pay) APIs

APIs for online B2B underwriting (quote, activation, payment).
 

EEFL (Each and Every First Loss) APIs

The deductible amount applied to each individual insurance claim before coverage applies.
 

Endpoint

A specific API function or service accessible via a URL path (e.g., create policy, check credit)..
 

Error Code

A code returned by the API indicating the type of error or issue encountered..
 

Exposure

The total value at risk with a specific buyer under your current policy.
 

Extended Notification

Optional webhook notification that sends the functional (final) decision.
 

 

F

 

Financial Reports

Public financial details (revenues, assets, ratios) available via the Financial Reports API.
 

Fraud Screening

Real-time evaluation of transaction data to detect high-risk or suspicious activity.

 

 

G

 

Grade (1-10)

This is a creditworthiness rating, where 1 represents the strongest credit quality and 10 represents the weakest.

 

Grade Check API

Provides grade, historical changes, financial data (when available), and monitoring (webhooks).
 

Grade Based Cover

A simplified insurance product where cover amount is determined by the buyer’s grade bracket.
 

 

H

 

HTTP Methods

The actions used in API calls such as GET (retrieve), POST (create), PUT (update), and DELETE (remove).
 

 

I

 

IDP (Identity Provider)

A service that authenticates clients and issues OAuth2 access tokens based on your API key.

 

Identifier Types (Company)

Business registration formats per country (VAT, ACN, TAXCIS…).
A service that authenticates clients and issues OAuth2 access tokens based on your API key.

 

Information Product

A service that gives you credit risk information about companies, including a credit grade from 1 (strongest) to 10 (weakest) and real‑time financial insights
 

 

J

 

JobId

An ID returned when your request is processed asynchronously.

 

Jobs API

API used to check the status of asynchronous requests.
 

Jobs Status

A job is pending when the system is still working on it, and processed when it’s finished and provides a resource link or a decision.
 

 

K

 

KPIs API

Provides policy‑level metrics such as loss ratio, risk KPIs, claims counts, and commercial KPIs.
 

KYB (Know Your Business)

It means checking that a business is real and trustworthy by verifying its company details through Allianz Trade’s global database before you allow that business to use your app or services.
 

KYC (Know Your Customer)

It means checking that the individual making the purchase is really who they say they are, using digital identity checks during onboarding.
 

 

L

 

Loss Ratio

The policy performance metric is calculated as claims paid divided by premium collected.
 

 

M

 

Monitoring (Grade or Cover)

Ability to track changes (like grade updates or cover changes) via webhooks or API polling.
 

 

N

 

NA (Not Available - Grade)

Returned when a company has no grade.
 

ND Cover (France)

Simplified cover request for French policyholders, offering predefined protection.
 

 

O

 

OAuth2

A secure token-based authentication protocol used to connect to protected Allianz Trade APIs.
 

OAuth2 Token

Temporary token that gives your system permission to call the APIs.
 

Overdue Reporting

Informing Allianz Trade that a buyer has not paid on time, typically required before submitting a claim.
 

 

P

 

Pagination

Used in search APIs, e.g. pageSize, to limit returned results.

 

Partial Payment (Overdues)

Feature in Payment Overdues API to report partial settlement.

 

Payment Overdues API

Reports overdue invoices and requests extensions or rescheduling.

 

payment Terms Offer

The result of the API-based risk decisioning that determines the payment period offered to a buyer (e.g., net 30, net 60).

 

policy

Your agreement with Allianz Trade outlining what’s covered, under what conditions, and to what extent.

 

portfolio Analysis

Assessment tools or API feeds that give visibility into overall risk across all your buyers.

 

Postman Collections

Ready‑to-use API testing collections provided by Allianz Trade.

 

Purchaser Verification (Fraud Engine)

Fraud‑checking step during E‑commerce checkout.

 

Principal

The party whose obligations are being guaranteed under a surety bond (often your customer).

 

Production Environment

The live environment where your application uses real data and interacts with actual Allianz Trade services.

 


 

Q

 

Quote (E‑commerce)

An underwriting proposal generated during checkout before activating a transaction cover.

 

Quotation

Requestor makes a quotation request before activating or rejecting the guarantee.

 


 

R

 

Rate Limit

A restriction on how many API calls you can make in a certain period to maintain system stability.

 

Real-Time Decisioning

The ability to instantly approve or decline a buyer or transaction using Allianz Trade’s risk intelligence.

 

Reference Data API

Provides country codes, identifier types, business unit codes, etc.

 

Refresh Token

A token that allows your app to request a new access token without requiring user login again.

 

Request Type Code

Indicates which type of cover you’re requesting in V3 (e.g., Primary, CAP, GradePolicyCoverBasic).

 

Requestor

Allianz Trade Surety client or the contractor.

 

REST

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.

 

Retry Policy

Guidelines for how your application should handle failed API calls, including retry attempts.

 

Risk Grade

An internal Allianz Trade rating that evaluates a company’s financial stability and creditworthiness.

 


 

S

 

Sandbox

A secure test environment where you can simulate API calls without impacting real data or live services.

 

SAP Credit Management Connector

SAP extension allowing Allianz Trade data (grades, risk info, limits) to be used inside SAP workflows.

 

Sector Risk / Country Risk

Macro-level risk indicators included in Grade Check responses

 

Status Codes

Codes representing business outcome (e.g., rejected, cancelled, already agreed).

.

Surety Bond

A financial guarantee provided by Allianz Trade that ensures contractual or regulatory obligations are fulfilled.

 


 

T

 

Technical Notification

Webhook informing you a job is technically processed (not the final decision).

 

Throttling

Temporary limiting of  API request rates when the limit is exceeded.

 

Time To Live (TTL)

Duration (in hours) that your webhook subscription is valid.

 

Transaction (E‑commerce)

A commercial action that results in an invoice. In E‑commerce, each transaction may be insured.

 

Transaction ID

A unique identifier assigned to each API call or process for tracking and troubleshooting.

 


 

U

 

UAT (User Acceptance Testing) Environment

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.

 

UATM (User Acceptance Test Management)

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.

 

Underwriting Criteria

The financial and legal factors Allianz Trade evaluates before approving a bond or credit coverage.

 

Unidentified Company

A company for which no CompanyId exists yet; details must be provided manually in cover requests.

 


 

W

 

Webhook

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.

 

Whitelisting

Your domain/IP must be approved before receiving webhooks.