Skip to content

EBL 3.0: SD-2793: Update API description #600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HenrikHL merged 2 commits into from
Jan 27, 2026
Merged

EBL 3.0: SD-2793: Update API description #600

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fee0514
EBL 3.0: SD-2793: Update API description
HenrikHL Jan 27, 2026
8022fe9
Improve "To order/Negotiable eBL documents" description
HenrikHL Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pint/v3/EBL_PINT_v3.0.0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ info:
The envelope transfer from the sending eBL Platform to the receiving eBL Platform always contains the **eBL document** (transferred via [**'Start envelope transfer'**](#/Start%20envelope%20transfer) endpoint request body [`EblEnvelope.transportDocument`](#/EblEnvelope) schema object). The eBL document must be unchanged between different envelope transfers for the lifetime of the eBL document.

The PINT API is designed to support transfer of the following types of eBL documents:
1. Straight eBL documents. This type of eBL document is defined by [`EblEnvelope.transportDocument.isToOrder`](#/EblEnvelope) attribute to `false`
2. Blank-endorsed eBL documents. This type of eBL document is created by setting [`EblEnvelope.transportDocument.isToOrder`](#/EblEnvelope) attribute to `true`, and making sure that [`EblEnvelope.transportDocument.documentParties[]`](#/EblEnvelope) list does not contain document party where `DocumentParty.partyFunction` has value `END` (Endorsee)
3. To-order/Negotiable eBL documents. This type of eBL document is created by setting the [`EblEnvelope.transportDocument.isToOrder`](#/EblEnvelope) attribute to `true`, and making sure that [`EblEnvelope.transportDocument.documentParties[]`](#/EblEnvelope) list contains document party where `DocumentParty.partyFunction` has value `END` (Endorsee). If the current endorsee party is also in possession of the eBL (possessor), this party can endorse some other party on the same eBL Platform (and make that other party new endorsee) by executing transaction with [`Transaction.actionCode`](#/Transaction) type `ENDORSE` (Endorsement). The DCSA PINT API support To-order/Negotiable documents, however, given that not all of the eBL solution providers support the split between possession and endorsements, this doesn't apply yet to interoperable eBL
1. Straight eBL documents. This type of eBL document is defined by [`EblEnvelope.transportDocument.isToOrder`](#/EblEnvelope) attribute to `false`.
2. Blank-endorsed eBL documents. This type of eBL document is created by setting [`EblEnvelope.transportDocument.isToOrder`](#/EblEnvelope) attribute to `true`, and making sure that [`EblEnvelope.transportDocument.documentParties`](#/EblEnvelope) object does **not** contain an `endorsee` document party.
3. To-order/Negotiable eBL documents. This type of eBL document is created by setting the [`EblEnvelope.transportDocument.isToOrder`](#/EblEnvelope) attribute to `true` and ensuring that the [`EblEnvelope.transportDocument.documentParties`](#/EblEnvelope) object contains an `endorsee` document party. If the current endorsee is also in possession of the eBL (i.e. is the possessor), that party may endorse the EBL to another party - either on the same eBL Platform or on a different eBL Platform - thereby making that other party the new endorsee. This is done by executing a transaction with [`Transaction.actionCode`](#/Transaction) set to `ENDORSE`, `ENDORSE_TO_ORDER` or `BLANK_ENDORSE`. The DCSA PINT API support To-order/Negotiable documents accross platforms; however, it is the responsibility of each eBL Solution Provider to validate whether the receiving platform supports such documents.

<h2>The Additional Documents</h2>

Expand Down