Download OpenAPI specification:Download
In the normal course of business, especially within the project business (e.g. construction) an applicant will need to arrange for a guarantee to be issued in favor of a beneficiary (normally its customer or buyer). The applicant will do this through a Guarantor (financial institution) that will issue the guarantee contract and be obligated by its terms. Today's challenge is that the storage of guarantees is decentralized while the guarantee related process is manual and paper based. The Guarantee Vault Platform seeks to create a centralized digital register that replaces the issued paper guarantee with its digital version. The digital guarantee would be issued by the guarantor on the GVP register and would retain the same legal authority as that held by the paper guarantee today.
GVP API looks to improve efficiency and increase transparency by replacing the decentralized paper process today with a centralized digital one that puts all market participants on the same digital page.
At heart, in its simplest form, the system allows:
Term/Acronym | Definition |
---|---|
Access Token | A credential that is used by an application to access an API. It informs the API that the bearer of the token has been authorized to access the API and perform specific actions specified by the scope that has been granted. In the case, Access Tokens are formed as JSON Web Tokens. They should be transmitted to the API as a Bearer credential in an HTTP Authorization header. |
API | Application Programming Interface |
Applicant | The entity whose payment or performance is secured. |
Beneficiary | The entity to which the guarantee is issued. |
client_id | A unique ID determining the subject identified by Oauth/OpenID Connect. |
Company | Refers to a corporate entity |
Corporate Guarantee | Corporate Guarantee is a guarantee in which a corporation agrees to be responsible for the financial obligations of, or the performance of, contractual obligations of another party (usually its subsidiary) in the event that the other party fails to discharge his financial obligations or perform the contractual obligations. |
DVS | Digital Vault Service GmbH company |
Financial Institution | Refers to both banks and insurance companies |
Guarantee | An irrevocable payment obligation of a financial institution. It serves to secure certain contractually agreed performance, warranty and/or payment obligations of the parties to the trade contracts. Payment is made on demand. The term “Guarantee” when used in this document shall refer to all of the previously defined instruments namely:
|
Guarantor | The entity providing the guarantee, namely a financial institution e.g. Bank, Insurance Company, Corporate. |
GVP | Guarantee Vault Platform (a product under DVS) |
GVP Register | The electronic register where the guarantor issues a new guarantee or posts an issuance action / event. Records made available on the GVP register are legally binding as per the terms of the guarantee contract once they become accessible by other transaction party(ies). |
JWKS URL | The URL where a Relying Party presents new JSON Web Key Sets to the GVP authorization Service without having to upload the key sets manually via the GVP Web admin GUI. |
JWT token | JSON Web Tokens. An open, industry standard RFC 7519 method for representing claims securely between two parties. You may decode well-formed JWTs at JWT.io to view their claims. |
Post Issuance Request | Refers to any requests coming after issuance of a guarantee from the applicant or beneficiary to the guarantor including:
|
private_key_jwt | Part of the cryptographic keypair that can be used to sign tokens that other parties can validate with the public key. |
Refresh Token | A special kind of token that can be used to obtain a renewed Access Token. It is useful for renewing expiring Access Tokens without interrupting the integration. Using the Refresh Token, the Relying Partner can request a new Access Token at any time. Refresh Tokens can be renewed each time a new access token is requested. |
Relying Party (RP) | The client application that supports OAuth 2.0 and relies on the OpenID provider to authenticate the end user and request claims about that user. In this case, it's the Guarantors system integrating with GVP. |
Standby Letter of Credit (SBLC) | A lender's guarantee of payment to an interested third-party in the event the lender’s client who requested the SBLC defaults on an agreement. |
Surety Bond (“Bürgschaft”) | A surety bond or surety (“Bürgschaft” in Germany) is a promise by a financial institution to pay one party(the obligee) a certain amount if a second party (the principal) fails to meet some obligation, such as fulfilling the terms of a contract. The surety bond protects the obligee against losses resulting from the principal's failure to meet the obligation. Surety bonds are usually validity type “Unlimited”, not payable on first demand and are a standard in Germany. Note: the surety bond (“Bürgschaft”) as such is regulated under the German Civil Code (“BGB”). |
Unique Customer Id | The guarantors unique Customer Id for the applicant in their proprietary system. |
Unlimited Validity | A guarantee for which the expiry is open-ended, i.e. it does not have a fixed expiry date. |
With all participants using the same platform and rules, GVP will allow for a more streamlined end to end process. Once the guarantor validates, approves and issues the guarantee, the applicant will have the possibility to make it immediately available to the beneficiary via GVP. The beneficiary at that point (whether registered with GVP or not) will then have access to the guarantee in GVP with the possibility to view details or even print the guarantee if required.
Although GVP will be available through a user interface, the majority of participants will interact with GVP using APIs to their proprietary in-house systems. This document will detail the API specifications for Guarantors.
Security Scheme Type | OAuth2 |
---|---|
Client OAuth Flow - RFC6749 Section 4.4 | Authorization URL: https://vault/.../oauth/token* |
Name | Description |
---|---|
amendment:manage |
OpenID Connect scope for managing amendment requests |
amendment:view |
OpenID Connect scope for viewing amendment requests |
guarantee:manage |
OpenID Connect scope for managing guarantees |
guarantee-request:manage |
OpenID Connect scope for managing guarantee-requests |
guarantee-request:view |
OpenID Connect scope for viewing guarantee-requests |
guarantee:view |
OpenID Connect scope for viewing guarantees |
notification:manage |
OpenID Connect scope for managing notifications |
notification:view |
OpenID Connect scope for viewing notifications |
release:manage |
OpenID Connect scope for managing release requests |
release:view |
OpenID Connect scope for viewing release requests |
claim:manage |
OpenID Connect scope for managing claim requests |
claim:view |
OpenID Connect scope for viewing claim requests |
Relying Party will authenticate using its client_id
(created during registration) and the private_key_jwt
(according to OpenID Connect Core 1.0 chapter 9).
During the authentication process the Relying Party should generate a JWT token as described in RFC7523 section 2.2 and sign it using their private key and the RS256
algorithm (RFC7518 section 3.1).
If the Relying Party has been registered with "JWKS URL" option, the client developers should implement the corresponding endpoint on the guarantors side that returns public key(s) used for the verification. Then implementation should be done according to RFC7517 (page 10).
Company admin users can create service accounts for a Relying Party. GVP system will generate a client_id
for the new service account and then, the company admin will choose an application name (an informative label) and select the method to transmit the client's public key or certificate. This could be done via:
The keypair will be required for the verification process. The preferred option for key handling is using the JWKS URL.
Using JWKS URL, the new keypairs will be downloaded from the client's JWKS endpoint. The other methods of communicating key-pairs will involve a manual step where company admin user re-imports the new key or certificate.
Access token
- expires in 1 hourRefresh token
- expires in 2 hoursWhen the access token
expires, the Relying Party shall use the refresh token
in order to get a new access token or repeat the authentication process from the beginning.
Participants should implement this functionality or use any libraries that already provide a refresh token functionality “out of the box”.
Errors that return an error object will always return a JSON object with attributes as specified below.
type
- string
about:blank
.title
- string
status
- number
detail
- string
instance
- string
This API will cover the following workflow actions / scenarios
ID | ACTION | DESCRIPTION |
---|---|---|
1 | Guarantee Request | Receipt of guarantee request (Applicant → GVP → Guarantor) |
2 | Guarantee Issuance | Send guarantee issuance notice (Guarantor → GVP → Applicant & Beneficiary) |
3 | Guarantee Return | Send guarantee request back (Guarantor → GVP → Applicant) |
4 | Amendment Request | Receipt of amendment request (Applicant → GVP → Guarantor) |
5 | Amendment Issuance | Send amendment notice (Guarantor → GVP → Applicant & Beneficiary) |
6 | Amendment Return | Send amendment request back (Guarantor → GVP → Applicant) |
7 | Claim Request | Receipt of claim request (Beneficiary → GVP → Guarantor) |
8 | Claim Issuance | Send claim notice (Guarantor → GVP → Applicant & Beneficiary) |
9 | Claim Return | Send claim request back (Guarantor → GVP → Beneficiary) |
10 | Release Request | Receipt of release request (Applicant or Beneficiary → GVP → Guarantor) |
11 | Release Issuance | Send release notice (Guarantor → GVP → Applicant & Beneficiary) |
12 | Release Return | Send release request back (Guarantor → GVP → Applicant or Beneficiary) |
13 | Close Issuance | Send close notice (Guarantor → GVP → Applicant & Beneficiary) |
14 | Certificate of Authenticity report | Retrieve certificate of authenticity report for guarantee (Guarantor) |
RESUBMITTED
Post issuance events are actions occurring on the guarantee after it has been issued. These include but are not limited to the following:
Please refer to section “Scope of the API” for more information on post-issuance requests
As well as manually polling the notification API, any API Client can subscribe to notification events in the GVP system through Webhooks.
Company admin user will have an option to configure the following webhook parameters for the API client:
The HMAC signature will allow the API client to ensure that POST requests sent to the Payload URL are from GVP.
GVP will calculate a signature (based on a secret, the notification payload and the `HMAC SHA256` algorithm) and include it into X-Vault-Signature header in the webhook POST request as Base64-encoded hex value. The Client should implement the signature verification for these requests.
There are no retries of failed webhook deliveries and no API for listing or retrieving failed webhook events.
Therefore, the client service that exposes an endpoint for webhooks (see Payload URL) must be highly available.
In case of any issues/maintenance on client service, API client should itself request/poll /v0/notifications/new
endpoint (provided by GVP) in order to get missed notifications.
The notifications received through the webhook mechanism should still be acknowledged through the Acknowledge endpoint after being persisted by the Client API.
When processing the requests to the API, different errors and exceptions can occur. The error states are listed in each request.
Most of GVP errors can be found on https://api-docs.guarantee-vault.com/errors/ErrorResponses.html
title
field in response body displays exception type
type
field in response body points to specific error description. For example, https://api-docs.guarantee-vault.com/errors/ErrorResponses.html#InvalidGuaranteeParticipantException
The explicit “Acknowledge” is required as the GVP system needs confirmation that each system has received the expected data.
When an Acknowledge is made by the client to GVP, GVP assumes that client received the data correctly and that it has been securely persisted into its proprietary system.
Without this explicit acknowledge, it is impossible for GVP to be certain that there were no technical difficulties and that the data was correctly received by the client’s system.
Currently this is not within the scope of the API however this will be made available via the GVP web UI.
If there are any questions regarding the API of the GVP system please contact us at [email protected]
.
This changelog lists all additions and updates to the Guarantee Vault API, in chronological order. Changes can be in the following categories:
governingLawSubdivision
for specifying the Subdivision of a Governing Law Country in a Guarantee.placeOfJurisdiction
in a Guarantee can only be filled if governingLaw
is filled.deliveryAddress
in a Guarantee can also be filled optionally if APPLICANT
, BENEFICIARY
or OBLIGOR
was selected to capture delivery details.deliveryAddress
in a Guarantee increased to 780 characters. issuance.ref
) to 140 characters (guarantee, amendment, claim, release).sender
in Retrieve Release Request and Retrieve Claim Request.minItems: 0
and maxItems: 10
, not mandatory.The notifications gives the system a list of data of various types. The client should GET the document and referenced file resources. When the client is certain that the data is persisted to its system, a call to the Acknowledgement should be made.
The various resources will be available until they are explicitly acknowledged.
Retrieve up to limit
un-acknowledged notifications from the notification inbox. This operation can be called either with or without a notification type
, if type
is omitted you will receive notifications from all channels/types. The latter is the suggested default, unless integration reasons dictate otherwise.
Although the requesting client is free to acknowledge at any time soon after receiving the notification, it is preferable that the object is retrieved before doing so.
type | string |
limit | string Default: 5 |
{- "notifications": [
- {
- "notificationId": "c198f31c-aa25-4ca7-8989-a93b9356e088",
- "type": "GUARANTEE_REQUEST",
- "event": "GUARANTEE_REQUEST_SUBMITTED",
- "participantRole": "APPLICANT",
- "notificationCreatedDate": "2020-10-04T14:19:22.321Z",
- "requestId": "667e8fa3-3f80-45f9-8aab-d72eac5735a8",
- "guaranteeId": null
}, - {
- "notificationId": "c5131bd2-46f1-4de1-b58d-5ee545487441",
- "type": "AMENDMENT",
- "event": "AMENDMENT_REQUEST_PUBLISHED",
- "participantRole": "GUARANTOR",
- "notificationCreatedDate": "2020-10-04T14:19:22.321Z",
- "requestId": "667e8fa3-3f80-45f9-8aab-d72eac5735a8",
- "guaranteeId": "82711181-00e3-4963-92e5-afe3a181c667"
}, - {
- "notificationId": "d804c5a4-128e-473a-82d4-1972c2a23a6e",
- "type": "RELEASE",
- "event": "RELEASE_REQUEST_PUBLISHED",
- "participantRole": "GUARANTOR",
- "notificationCreatedDate": "2020-10-04T14:19:22.321Z",
- "requestId": "667e8fa3-3f80-45f9-8aab-d72eac5735a8",
- "guaranteeId": "82711181-00e3-4963-92e5-afe3a181c667"
}, - {
- "notificationId": "ee9bd74e-678c-4386-8ce0-04e814645f7c",
- "type": "CLAIM",
- "event": "CLAIM_REQUEST_PUBLISHED",
- "participantRole": "GUARANTOR",
- "notificationCreatedDate": "2020-10-04T14:19:22.321Z",
- "requestId": "667e8fa3-3f80-45f9-8aab-d72eac5735a8",
- "guaranteeId": "82711181-00e3-4963-92e5-afe3a181c667"
}
]
}
Marks the notification as received, and removes it from the notification inbox.
Although the requesting client is free to acknowledge at any time soon after receiving the notification, it is preferable that the object is retrieved before doing so.
notificationId required | string |
{- "notificationId": "2d591c23-85b1-4e8c-a6bd-74d89f8955c5",
- "status": "acknowledged"
}
Marks the notification as rejected, saves the rejection reason and removes it from the notification inbox.
Although the requesting client is free to reject at any time soon after receiving the notification, it is preferable that the object is retrieved before doing so.
notificationId required | string |
reason required | string <= 1000 characters Contains the reason for rejecting the notification |
{- "reason": "string"
}
{- "notificationId": "2d591c23-85b1-4e8c-a6bd-74d89f8955c5",
- "reason": "string",
- "status": "acknowledged"
}
Fetch up-to-date copy of the specified guarantee request.
guaranteeRequestId required | string <uuid> |
{- "status": "REQUESTED",
- "guaranteeRequestId": "ca6dede1-2b1d-49f0-9c04-ba7aa9df5986",
- "instrument": "BANK_GTEE",
- "obligor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "customerRef": "00987784CHFHJ",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicant": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "guarantor": {
- "id": "bcae7774-e905-4a15-99de-d92d363d3e1d",
- "name": "Bank AG",
- "address1": "Kaiser-Joseph-Strasse 34",
- "address2": "Kaiser-Joseph-Strasse 35",
- "city": "Donauwörth",
- "country": "DE",
- "province": "Bavaria",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Bank AG",
- "line2": "Kaiser-Joseph-Strasse 34",
- "line3": "Donauwörth,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "beneficiary": {
- "id": "6dbe6c11-227f-48be-8dd1-14158aa2a4c3",
- "name": "Company GmbH industrial boilers BU1",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "contactEmail": null,
- "unregistered": true,
- "language": null,
- "shortNameAndAddress": {
- "line1": "Company GmbH industrial boilers BU1",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicantRef": "CAGH0000345F",
- "formInstrument": "DIRECT",
- "guarantorDetailsSpecifiedBy": "APPLICANT",
- "guaranteeType": "ADVANCE_PAY",
- "guaranteeTypeOther": "Special Warranty Guarantee",
- "guaranteeWording": "WORDING_BENEFICIARY",
- "guaranteeWordingOther": "Other guarantee wording",
- "governingLaw": "DE",
- "governingLawSubdivision": "Bavaria",
- "placeOfJurisdiction": "Munich",
- "nominalAmount": {
- "currency": "EUR",
- "value": 175000
}, - "applicableRule": "ISPR",
- "applicableRuleOther": "Under German Jurisdiction",
- "validity": "LIMITED",
- "expiryDate": "2020-09-23",
- "expiryCondition": "Expiry condition",
- "referenceType": "CONTRACT",
- "referenceDate": "2020-07-23",
- "referenceExpiryDate": "2020-07-30",
- "contractNumber": "XS0000002334",
- "contractAmount": {
- "currency": "EUR",
- "value": 100000000
}, - "contractCoverage": "17.5",
- "instrumentPurpose": "DELIVER & INSTALL OF CEILING PANELS X 5",
- "deliveryType": "DIGITAL",
- "gvpDelivery": "APPLICANT_ONLY",
- "deliverTo": "APPLICANT",
- "deliveryAddress": "Company GmbH industrial boilers BU1, Maximilianstrasse 105, Schwäbisch Gmünd, Baden-Württemberg, DE",
- "deliveryMethod": "OTHR",
- "deliveryMethodDetails": "Additional Information delivery",
- "comments": "Additonal comment on the Guarantee",
- "guaranteeText": "Guarantee sample text",
- "guaranteeFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "otherAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "language": "en",
- "sent": {
- "name": "Company SE business unit 1",
- "date": "2020-09-10T12:16:51Z"
}, - "declined": {
- "reason": "any return reason",
- "date": "2020-09-10T12:16:51Z"
}, - "correspondentGuarantor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Kern GmbH",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "bicCode": "AAAABBCC00",
- "shortNameAndAddress": {
- "line1": "Kern GmbH",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "approvedBy": "Approved by John Doe",
- "demandIndicator": "NMLT",
- "charges": "Charges"
}
Issue a guarantee for the specified guarantee request.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeRequestId required | string |
required | object (IssueGuaranteeRequest) |
issuedGuaranteeFiles required | Array of strings <binary> = 1 items The Guarantee file should be supplied here. Currently only |
additionalAttachments | Array of strings <binary> [ 0 .. 10 ] items Additional Attachments visible for Applicant and Beneficiary Issuer might provide extra information related to the guarantee(release letter templates, signatory book, etc) Can be multiple files. Allowed content types:
|
additionalAttachmentsApplicant | Array of strings <binary> [ 0 .. 10 ] items Additional Attachments visible for Applicant Issuer might provide extra information related to the guarantee(release letter templates, signatory book, etc) Can be multiple files. Allowed content types:
|
{- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "ISSUED",
- "issuance": {
- "ref": "string",
- "date": "2020-09-01",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "additionalAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Return the specified Guarantee Request to Applicant.
A notification of the declined guarantee request is sent to the applicant, with the option to re-apply after correcting any issues found with the guarantee request.
guaranteeRequestId required | string <uuid> |
reason required | string <= 1000 characters Contains guarantors reason for returning the request |
{- "reason": "string"
}
{- "guaranteeRequestId": "ca6dede1-2b1d-49f0-9c04-ba7aa9df5986",
- "date": "2019-08-24T14:15:22Z",
- "reason": "string"
}
Retrieve Guarantees up to limit
for specified page. The response can filtered by applicantRef
and issuerRef
applicantRef | string |
issuerRef | string |
page | string Default: 0 |
limit | string <= 50 Default: 5 |
{- "guarantees": [
- {
- "status": "REQUESTED",
- "contractNumber": "XS0000002334",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "instrument": "BANK_GTEE",
- "obligor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "customerRef": "00987784CHFHJ",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicant": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "guarantor": {
- "id": "bcae7774-e905-4a15-99de-d92d363d3e1d",
- "name": "Bank AG",
- "address1": "Kaiser-Joseph-Strasse 34",
- "address2": "Kaiser-Joseph-Strasse 35",
- "city": "Donauwörth",
- "country": "DE",
- "province": "Bavaria",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Bank AG",
- "line2": "Kaiser-Joseph-Strasse 34",
- "line3": "Donauwörth,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "beneficiary": {
- "id": "6dbe6c11-227f-48be-8dd1-14158aa2a4c3",
- "name": "Company GmbH industrial boilers BU1",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "contactEmail": null,
- "unregistered": true,
- "language": null,
- "shortNameAndAddress": {
- "line1": "Company GmbH industrial boilers BU1",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicantRef": "CAGH0000345F",
- "formInstrument": "DIRECT",
- "guarantorDetailsSpecifiedBy": "APPLICANT",
- "guaranteeType": "ADVANCE_PAY",
- "guaranteeTypeOther": "Special Warranty Guarantee",
- "guaranteeWording": "WORDING_BENEFICIARY",
- "guaranteeWordingOther": "Other guarantee wording",
- "governingLaw": "DE",
- "governingLawSubdivision": "Bavaria",
- "placeOfJurisdiction": "Munich",
- "nominalAmount": {
- "currency": "EUR",
- "value": 175000
}, - "applicableRule": "ISPR",
- "applicableRuleOther": "Under German Jurisdiction",
- "validity": "LIMITED",
- "expiryDate": "2020-09-23",
- "expiryCondition": "Expiry condition",
- "referenceType": "CONTRACT",
- "referenceDate": "2020-07-23",
- "referenceExpiryDate": "2020-07-30",
- "contractAmount": {
- "currency": "EUR",
- "value": 100000000
}, - "contractCoverage": "17.5",
- "instrumentPurpose": "DELIVER & INSTALL OF CEILING PANELS X 5",
- "deliveryType": "DIGITAL",
- "gvpDelivery": "APPLICANT_ONLY",
- "deliverTo": "APPLICANT",
- "deliveryAddress": "Company GmbH industrial boilers BU1, Maximilianstrasse 105, Schwäbisch Gmünd, Baden-Württemberg, DE",
- "deliveryMethod": "OTHR",
- "deliveryMethodDetails": "Additional Information delivery",
- "comments": "Additonal comment on the Guarantee",
- "guaranteeText": "Guarantee sample text",
- "guaranteeFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "otherAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "language": "en",
- "issuance": {
- "id": "91c2d8ae-2d8d-4cff-9bec-a631f3cd8836",
- "ref": "GTEE9120000111-1",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "additionalAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}, - "correspondentGuarantor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Kern GmbH",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "bicCode": "AAAABBCC00",
- "shortNameAndAddress": {
- "line1": "Kern GmbH",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "approvedBy": "Approved by John Doe",
- "demandIndicator": "NMLT",
- "charges": "Charges"
}
]
}
Issue a guarantee directly without a guarantee request.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
required | object (IssueGuarantee) |
issuedGuaranteeFiles required | Array of strings <binary> = 1 items The Guarantee file should be supplied here. Currently only |
additionalAttachments | Array of strings <binary> [ 0 .. 10 ] items Additional Attachments visible for Applicant and Beneficiary Issuer might provide extra information related to the guarantee(release letter templates, signatory book, etc) Can be multiple files. Allowed content types:
|
additionalAttachmentsApplicant | Array of strings <binary> [ 0 .. 10 ] items Additional Attachments visible for Applicant Issuer might provide extra information related to the guarantee(release letter templates, signatory book, etc) Can be multiple files. Allowed content types:
|
{- "status": "ISSUED",
- "contractNumber": null,
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "instrument": "BANK_GTEE",
- "obligor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "customerRef": null,
- "name": "Company SE",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicant": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Company SE",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "guarantor": {
- "id": "bcae7774-e905-4a15-99de-d92d363d3e1d",
- "name": "Bank AG",
- "address1": "Kaiser-Joseph-Strasse 34",
- "address2": "Kaiser-Joseph-Strasse 35",
- "city": "Donauwörth",
- "country": "DE",
- "province": "Bavaria",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Bank AG",
- "line2": "Kaiser-Joseph-Strasse 34",
- "line3": "Donauwörth,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "beneficiary": {
- "id": "6dbe6c11-227f-48be-8dd1-14158aa2a4c3",
- "name": "Company GmbH industrial boilers",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "unregistered": true,
- "language": null,
- "shortNameAndAddress": {
- "line1": "Company GmbH industrial boilers",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicantRef": null,
- "formInstrument": "DIRECT",
- "guaranteeType": "ADVANCE_PAY",
- "guaranteeTypeOther": "Special Warranty Guarantee",
- "guaranteeWording": null,
- "guaranteeWordingOther": null,
- "governingLaw": null,
- "governingLawSubdivision": null,
- "placeOfJurisdiction": null,
- "nominalAmount": {
- "currency": "EUR",
- "value": 175000
}, - "applicableRule": null,
- "applicableRuleOther": null,
- "validity": "LIMITED",
- "expiryDate": "2020-09-23",
- "expiryCondition": "Expiry condition",
- "referenceType": null,
- "referenceDate": null,
- "referenceExpiryDate": null,
- "contractAmount": null,
- "contractCoverage": null,
- "instrumentPurpose": null,
- "deliveryType": "DIGITAL",
- "gvpDelivery": "APPLICANT_BENEFICIARY",
- "deliverTo": null,
- "deliveryAddress": null,
- "deliveryMethod": null,
- "deliveryMethodDetails": null,
- "comments": null,
- "guaranteeText": null,
- "guaranteeFiles": [ ],
- "otherAttachments": [ ],
- "language": null,
- "issuance": {
- "id": "91c2d8ae-2d8d-4cff-9bec-a631f3cd8836",
- "ref": "GTEE9120000111-1",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "additionalAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}, - "correspondentGuarantor": null,
- "approvedBy": null,
- "demandIndicator": null,
- "charges": null
}
Up-to-date copy of the specified guarantee. The retrieved guarantee can be in any state.
guaranteeId required | string |
{- "status": "REQUESTED",
- "contractNumber": "XS0000002334",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "instrument": "BANK_GTEE",
- "obligor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "customerRef": "00987784CHFHJ",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicant": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "guarantor": {
- "id": "bcae7774-e905-4a15-99de-d92d363d3e1d",
- "name": "Bank AG",
- "address1": "Kaiser-Joseph-Strasse 34",
- "address2": "Kaiser-Joseph-Strasse 35",
- "city": "Donauwörth",
- "country": "DE",
- "province": "Bavaria",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Bank AG",
- "line2": "Kaiser-Joseph-Strasse 34",
- "line3": "Donauwörth,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "beneficiary": {
- "id": "6dbe6c11-227f-48be-8dd1-14158aa2a4c3",
- "name": "Company GmbH industrial boilers BU1",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "contactEmail": null,
- "unregistered": true,
- "language": null,
- "shortNameAndAddress": {
- "line1": "Company GmbH industrial boilers BU1",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "applicantRef": "CAGH0000345F",
- "formInstrument": "DIRECT",
- "guarantorDetailsSpecifiedBy": "APPLICANT",
- "guaranteeType": "ADVANCE_PAY",
- "guaranteeTypeOther": "Special Warranty Guarantee",
- "guaranteeWording": "WORDING_BENEFICIARY",
- "guaranteeWordingOther": "Other guarantee wording",
- "governingLaw": "DE",
- "governingLawSubdivision": "Bavaria",
- "placeOfJurisdiction": "Munich",
- "nominalAmount": {
- "currency": "EUR",
- "value": 175000
}, - "applicableRule": "ISPR",
- "applicableRuleOther": "Under German Jurisdiction",
- "validity": "LIMITED",
- "expiryDate": "2020-09-23",
- "expiryCondition": "Expiry condition",
- "referenceType": "CONTRACT",
- "referenceDate": "2020-07-23",
- "referenceExpiryDate": "2020-07-30",
- "contractAmount": {
- "currency": "EUR",
- "value": 100000000
}, - "contractCoverage": "17.5",
- "instrumentPurpose": "DELIVER & INSTALL OF CEILING PANELS X 5",
- "deliveryType": "DIGITAL",
- "gvpDelivery": "APPLICANT_ONLY",
- "deliverTo": "APPLICANT",
- "deliveryAddress": "Company GmbH industrial boilers BU1, Maximilianstrasse 105, Schwäbisch Gmünd, Baden-Württemberg, DE",
- "deliveryMethod": "OTHR",
- "deliveryMethodDetails": "Additional Information delivery",
- "comments": "Additonal comment on the Guarantee",
- "guaranteeText": "Guarantee sample text",
- "guaranteeFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "otherAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "language": "en",
- "issuance": {
- "id": "91c2d8ae-2d8d-4cff-9bec-a631f3cd8836",
- "ref": "GTEE9120000111-1",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "additionalAttachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}, - "correspondentGuarantor": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Kern GmbH",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "bicCode": "AAAABBCC00",
- "shortNameAndAddress": {
- "line1": "Kern GmbH",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "approvedBy": "Approved by John Doe",
- "demandIndicator": "NMLT",
- "charges": "Charges"
}
Up-to-date copy of the specified amendment. The amendment can be in any state.
guaranteeId required | string |
amendmentRequestId required | string |
{- "amendmentRequestId": "f62d9c3e-1bd6-4c13-9f52-d1b5092380b3",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "REQUESTED",
- "originator": "APPLICANT",
- "nominalAmount": {
- "currency": "EUR",
- "value": 3500,
- "type": "INCREASE"
}, - "applicant": {
- "id": "80d0c5dd-7d0b-4b19-834d-c4e1ff70008e",
- "name": "Company SE business unit 1",
- "address1": "Donnersbergerstrasse 4",
- "address2": "Donnersbergerstrasse 4",
- "city": "Hamburg",
- "country": "DE",
- "province": "Schleswig-Holstein",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company SE business unit 1",
- "line2": "Donnersbergerstrasse 4",
- "line3": "Hamburg,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "beneficiary": {
- "id": "6dbe6c11-227f-48be-8dd1-14158aa2a4c3",
- "name": "Company GmbH industrial boilers BU1",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company GmbH industrial boilers BU1",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "validity": "LIMITED",
- "expiryDate": "2020-09-23",
- "expiryCondition": "Expiry condition",
- "referenceType": "CONTRACT",
- "guaranteeType": "ADVANCE_PAY",
- "guaranteeTypeOther": "Special Warranty Guarantee",
- "guaranteeWording": "WORDING_BENEFICIARY",
- "guaranteeWordingOther": "Other guarantee wording",
- "referenceDate": "2020-07-23",
- "referenceExpiryDate": "2020-07-30",
- "contractNumber": "XS0000002334",
- "contractAmount": {
- "currency": "EUR",
- "value": 50000,
- "type": "NEW"
}, - "instrumentPurpose": "DELIVER & INSTALL OF CEILING PANELS X 5",
- "details": {
- "type": "OTHER",
- "info": "Sample Amendment details."
}, - "bankInformation": "some useful information from Corporate X",
- "guaranteeText": "Guarantee sample text",
- "guaranteeFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "attachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "issuance": {
- "ref": "string",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}, - "sent": {
- "name": "Company SE business unit 1",
- "date": "2020-09-10T12:16:51Z"
}, - "declined": {
- "reason": "any return reason",
- "date": "2020-09-10T12:16:51Z"
}, - "approvedBy": "Approved by John Doe",
- "governingLaw": "DE",
- "governingLawSubdivision": "Bavaria",
- "placeOfJurisdiction": "Munich",
- "demandIndicator": "NMLT",
- "charges": "Charges",
- "deliverTo": "APPLICANT",
- "deliveryAddress": "Company GmbH industrial boilers BU1, Maximilianstrasse 105, Schwäbisch Gmünd, Baden-Württemberg, DE",
- "deliveryMethod": "OTHR",
- "deliveryMethodDetails": "Additional Information delivery"
}
Amendments are issued after processing amendment requests sent in by the Applicant or Beneficiary. The Amendment Request contains details which should render an updated Guarantee Document, which is sent in on the issuance of the amendment.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string |
amendmentRequestId required | string |
required | object (IssueAmendmentRequest) |
issuedGuaranteeFiles | Array of strings <binary> [ 0 .. 10 ] items The Guarantee files visible for Applicant and Beneficiary should be supplied here. Allowed content types:
|
issuedGuaranteeFilesApplicant | Array of strings <binary> [ 0 .. 10 ] items The Guarantee files visible for Applicant should be supplied here. Allowed content types:
|
{- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "amendmentRequestId": "f62d9c3e-1bd6-4c13-9f52-d1b5092380b3",
- "status": "ISSUED",
- "issuance": {
- "ref": "string",
- "date": "2020-09-01",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Return Amendment Request
guaranteeId required | string <uuid> |
amendmentRequestId required | string <uuid> |
reason required | string <= 1000 characters Reason for returning the Amendment. |
{- "reason": "string"
}
{- "amendmentRequestId": "f62d9c3e-1bd6-4c13-9f52-d1b5092380b3",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "date": "2019-08-24T14:15:22Z",
- "reason": "string"
}
Create and Issue Amendment in GVP system on behalf of different participants. This makes it available for the Beneficiary.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string |
required | object (IssueAmendment) |
guaranteeFiles | Array of strings <binary> [ 0 .. 10 ] items Guarantee Files If field "guaranteeWording" is set to "WORDING_APPLICANT" wording of applicant or "WORDING_BENEFICIARY" wording of beneficiary the user must either populate the field "guaranteeText" or attach file in field guaranteeFiles Allowed content types:
|
attachments | Array of strings <binary> [ 0 .. 10 ] items Attachments Other information related to the request can be attached here. Can be multiple files Allowed content types:
|
issuedGuaranteeFiles | Array of strings <binary> [ 0 .. 10 ] items The Guarantee file visible for Applicant and Beneficiary should be supplied here. Allowed content types:
|
issuedGuaranteeFilesApplicant | Array of strings <binary> [ 0 .. 10 ] items The Guarantee file visible for Applicant should be supplied here. Allowed content types:
|
{- "amendmentRequestId": "f62d9c3e-1bd6-4c13-9f52-d1b5092380b3",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "REQUESTED",
- "originator": "APPLICANT",
- "requestor": "APPLICANT",
- "nominalAmount": {
- "currency": "EUR",
- "value": 3500,
- "type": "INCREASE"
}, - "beneficiary": {
- "id": "6dbe6c11-227f-48be-8dd1-14158aa2a4c3",
- "name": "Company GmbH industrial boilers BU1",
- "address1": "Maximilianstrasse 105",
- "address2": "Maximilianstrasse 106",
- "city": "Schwäbisch Gmünd",
- "country": "DE",
- "province": "Baden-Württemberg",
- "postalCode": 92032,
- "shortNameAndAddress": {
- "line1": "Company GmbH industrial boilers BU1",
- "line2": "Maximilianstrasse 105",
- "line3": "Schwäbisch Gmünd,92032",
- "line4": "Germany",
- "autogenerated": true
}
}, - "validity": "LIMITED",
- "expiryDate": "2020-09-23",
- "expiryCondition": "Expiry condition",
- "referenceType": "CONTRACT",
- "guaranteeType": "ADVANCE_PAY",
- "guaranteeTypeOther": "Special Warranty Guarantee",
- "guaranteeWording": "WORDING_BENEFICIARY",
- "guaranteeWordingOther": "Other guarantee wording",
- "referenceDate": "2020-07-23",
- "referenceExpiryDate": "2020-07-30",
- "contractNumber": "XS0000002334",
- "contractAmount": {
- "currency": "EUR",
- "value": 50000,
- "type": "NEW"
}, - "instrumentPurpose": "DELIVER & INSTALL OF CEILING PANELS X 5",
- "details": {
- "type": "OTHER",
- "info": "Sample Amendment details."
}, - "bankInformation": "some useful information from Corporate X",
- "guaranteeText": "Guarantee sample text",
- "guaranteeFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "attachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "sent": {
- "name": "Company SE business unit 1",
- "date": "2020-09-10T12:16:51Z"
}, - "approvedBy": "Approved by John Doe",
- "governingLaw": "DE",
- "governingLawSubdivision": "Bavaria",
- "placeOfJurisdiction": "Munich",
- "demandIndicator": "NMLT",
- "charges": "Charges",
- "deliverTo": "APPLICANT",
- "deliveryAddress": "Company GmbH industrial boilers BU1, Maximilianstrasse 105, Schwäbisch Gmünd, Baden-Württemberg, DE",
- "deliveryMethod": "OTHR",
- "deliveryMethodDetails": "Additional Information delivery",
- "issuance": {
- "ref": "string",
- "date": "2020-09-01",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Up-to-date copy of the specified release. The release can be in any state.
guaranteeId required | string |
releaseRequestId required | string |
{- "releaseRequestId": "52fa10f0-dae9-42a5-8c65-9d09b483fb63",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "REQUESTED",
- "originator": "APPLICANT",
- "requestedReleaseDate": "2019-08-24",
- "amount": {
- "currency": "EUR",
- "value": 175000
}, - "reason": "BUFI",
- "reasonOther": "We need clarification on X, Y and Z. Please refer to email sent to Klaus Smith 2020-10-13. ",
- "message": "Any useful message to Guarantor",
- "supportingDocuments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "sent": {
- "name": "Company SE business unit 1",
- "date": "2020-09-10T12:16:51Z"
}, - "declined": {
- "reason": "any return reason",
- "date": "2020-09-10T12:16:51Z"
}, - "approvedBy": "Approved by John Doe",
- "sender": "string",
- "issuance": {
- "ref": "string",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Release the applicant from the guarantee.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string <uuid> |
releaseRequestId required | string <uuid> |
required | object (IssueReleaseRequest) |
issuedReleaseFiles | Array of strings <binary> >= 0 items The release issuance files visible for Applicant and Beneficiary should be supplied here. Allowed content types:
|
issuedReleaseFilesApplicant | Array of strings <binary> >= 0 items The release issuance files visible for Applicant should be supplied here.
|
{- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "releaseRequestId": "52fa10f0-dae9-42a5-8c65-9d09b483fb63",
- "status": "ISSUED",
- "issuance": {
- "ref": "string",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Return Release Request back to Beneficiary
guaranteeId required | string <uuid> |
releaseRequestId required | string <uuid> |
reason required | string <= 1000 characters Reason for returning the Release Request. |
{- "reason": "string"
}
{- "releaseRequestId": "52fa10f0-dae9-42a5-8c65-9d09b483fb63",
- "date": "2019-08-24T14:15:22Z",
- "reason": "string"
}
Create and Issue Release in GVP system on behalf of different participants. This makes it available for the Beneficiary.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string |
required | object (IssueRelease) |
supportingDocuments | Array of strings <binary> >= 0 items Supporting Documents Other information related to the request can be attached here. Can be multiple files Allowed content types:
|
issuedReleaseFiles | Array of strings <binary> >= 0 items The release issuance files visible for Applicant and Beneficiary should be supplied here. Allowed content types:
|
issuedReleaseFilesApplicant | Array of strings <binary> >= 0 items The release issuance files visible for Beneficiary should be supplied here. Allowed content types:
|
{- "releaseRequestId": "52fa10f0-dae9-42a5-8c65-9d09b483fb63",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "REQUESTED",
- "originator": "APPLICANT",
- "amount": {
- "currency": "EUR",
- "value": 175000
}, - "reason": "BUFI",
- "reasonOther": "We need clarification on X, Y and Z. Please refer to email sent to Klaus Smith 2020-10-13. ",
- "message": "Any useful message to Guarantor",
- "supportingDocuments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "approvedBy": "Approved by John Doe",
- "issuance": {
- "ref": "string",
- "date": "2020-09-01",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}, - "requestor": "APPLICANT",
- "requestedReleaseDate": "2019-08-24"
}
The guarantee claim enables the guarantor to retrieve the up-to-date information on the specified claim request and execute(issue) it.
Retrieve Claim Request.
guaranteeId required | string |
claimRequestId required | string |
{- "claimRequestId": "ae6cd89f-9216-4c24-8f5b-59e86a5ccecd",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "REQUESTED",
- "originator": "APPLICANT",
- "requestor": "APPLICANT",
- "amount": {
- "currency": "str",
- "value": 0
}, - "date": "2019-08-24",
- "type": "PAYM",
- "newExpiryDate": "2019-08-24",
- "text": "string",
- "accountName": "string",
- "accountNumber": "string",
- "institutionName": "string",
- "claimFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "attachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "issuance": {
- "ref": "string",
- "date": "2019-08-24",
- "action": "EXECUTE",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}, - "sent": {
- "name": "Company SE business unit 1",
- "date": "2020-09-10T12:16:51Z"
}, - "declined": {
- "reason": "any return reason",
- "date": "2020-09-10T12:16:51Z"
}, - "approvedBy": "Approved by John Doe",
- "sender": "string"
}
Claims are issued after processing claim requests sent in by the Beneficiary. The Claim Request contains details which should render an updated Guarantee Document, which is sent in on the issuance of the claim.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string |
claimRequestId required | string |
required | object (IssueClaimRequest) |
claimAttachments | Array of strings <binary> >= 0 items References to Guarantee Claim Issuance files from issuing party which will be visible for Applicant and Beneficiary. Allowed content types:
|
claimAttachmentsApplicant | Array of strings <binary> >= 0 items References to Guarantee Claim Issuance files from issuing party which will be visible for Applicant. Allowed content types:
|
{- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "claimRequestId": "ae6cd89f-9216-4c24-8f5b-59e86a5ccecd",
- "issuance": {
- "ref": "string",
- "date": "2019-08-24",
- "action": "EXECUTE",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Return Claim Request back to Beneficiary
guaranteeId required | string <uuid> |
claimRequestId required | string <uuid> |
reason required | string <= 1000 characters Reason for returning the Claim. |
{- "reason": "string"
}
{- "claimRequestId": "ae6cd89f-9216-4c24-8f5b-59e86a5ccecd",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "date": "2019-08-24T14:15:22Z",
- "reason": "string"
}
Create and Issue Claim in GVP system on behalf of different participants. This makes it available for the Beneficiary.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string |
required | object (IssueClaim) |
claimFiles | Array of strings <binary> [ 0 .. 10 ] items Claim Files The client must either populate the Text of Claim field or attach file in field "claimFiles" Allowed content types:
|
attachments | Array of strings <binary> [ 0 .. 10 ] items Attachments Other information related to the request can be attached here. Can be multiple files Allowed content types:
|
claimAttachments | Array of strings <binary> >= 0 items References to Guarantee Claim Issuance files from issuing party which will be visible for Applicant and Beneficiary. Allowed content types:
|
claimAttachmentsApplicant | Array of strings <binary> >= 0 items References to Guarantee Claim Issuance files from issuing party which will be visible for Applicant. Allowed content types:
|
{- "claimRequestId": "ae6cd89f-9216-4c24-8f5b-59e86a5ccecd",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "REQUESTED",
- "originator": "APPLICANT",
- "requestor": "APPLICANT",
- "amount": {
- "currency": "str",
- "value": 0
}, - "date": "2019-08-24",
- "type": "PAYM",
- "newExpiryDate": "2019-08-24",
- "text": "string",
- "accountName": "string",
- "accountNumber": "string",
- "institutionName": "string",
- "claimFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "attachments": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "issuance": {
- "ref": "string",
- "date": "2020-09-01",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
], - "action": "EXECUTE"
}, - "sent": {
- "name": "Company SE business unit 1",
- "date": "2020-09-10T12:16:51Z"
}, - "declined": {
- "reason": "any return reason",
- "date": "2020-09-10T12:16:51Z"
}, - "approvedBy": "Approved by John Doe"
}
The guarantee close enables the guarantor to retrieve the up-to-date information on the specified close request.
Create and Issue Close in GVP system. This makes it available for the Applicant and Beneficiary.
For detailed information about the maximum size permitted for uploaded file and for the request overall, please read API usage paragraph.
guaranteeId required | string |
required | object (IssueClose) |
issuedCloseFiles | Array of strings <binary> >= 0 items The close issuance files visible for Applicant and Beneficiary should be supplied here. Allowed content types:
|
issuedCloseFilesApplicant | Array of strings <binary> >= 0 items The close issuance files visible for Applicant should be supplied here. Allowed content types:
|
{- "closeRequestId": "cb590b9d-037c-4f3f-90da-ef5d18642fed",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "ISSUED",
- "originator": "GUARANTOR",
- "reason": "We need clarification on X, Y and Z. Please refer to email sent to Klaus Smith 2020-10-13. ",
- "issuance": {
- "ref": "string",
- "date": "2020-09-01",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Up-to-date copy of the specified close request. The close request can be in ISSUED state only.
guaranteeId required | string |
closeRequestId required | string |
{- "closeRequestId": "cb590b9d-037c-4f3f-90da-ef5d18642fed",
- "guaranteeId": "ed62b7ef-5f7e-440e-ac76-46a77832e008",
- "status": "ISSUED",
- "originator": "GUARANTOR",
- "reason": "We need clarification on X, Y and Z. Please refer to email sent to Klaus Smith 2020-10-13. ",
- "issuance": {
- "ref": "string",
- "date": "2019-08-24",
- "issuanceFiles": [
- {
- "id": "c3ff6da2-97f1-42e7-bd0d-c28881b3609e",
- "blobName": "00e1d43e-2c23-4e70-899b-3397dbe1941example-file.pdf",
- "name": "example-file.pdf",
- "date": "2021-08-25T09:11:43.712Z",
- "visibility": "ALL"
}
]
}
}
Provides the possibility for the guarantor to download guarantee reports generated by GVP.
Generate the Certificate of Authenticity for an existing guarantee. The report is generated in pdf
format
guaranteeId required | string |
{- "title": "Required field is missing",
- "status": 400,
- "detail": { },
}