API docs by Redocly

TradeFinancingValidation (4.3.8)

Download OpenAPI specification:Download

MonetaGo Client Services: support@securefinancing.com URL: https://www.monetago.com/ License: Community API Redistribution License

Service for trade financing validation, fingerprinting and matching

TradeFinancingValidationService

APIS set that communicate between the bank and a trade receivables validation, fingerprinting and matching service.

Register Transactions.

Registers and optionally requests to finance the assets/transactions identified by the provided identifications at the validation service.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Request Body schema: application/json
required
Array of objects
pool_identification
string [ 1 .. 35 ] characters

Specifies a character string with a maximum length of 35 characters.

creation_date_time
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed. NOTE: the additional backslash '' character is required in the yaml file used in the java dto's (Col 118). This creates a descrepancy with the swagger and stoplight versions of the open api spec.
submitting_financial_institution_identification
string <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

Responses

Request samples

Content type
application/json
{
  • "pool_identification": "string",
  • "creation_date_time": "string",
  • "submitting_financial_institution_identification": "string",
  • "batch_collection": [
    ]
}

Response samples

Content type
application/json
{
  • "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}

Mark as Financed.

Requests the assets/transactions identified by the provided identifications to be marked as financed by the caller at the validation service.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Request Body schema: application/json
required
Array of objects
submitting_financial_institution_identification
required
string <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

batch_booking
boolean

Indicates a "Yes" or "No" type of answer for an element.

batch_booking_override
boolean

Indicates a "Yes" or "No" type of answer for an element.

Responses

Request samples

Content type
application/json
Example
{
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "financing_batch": [
    ]
}

Response samples

Content type
application/json
{
  • "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}

Create New Set.

Creates a new financing validation request set definition for subsequent status retrieval from the GET /status endpoint. Identifiers within the same BatchInformation8 object will produce the intersect of the identifiers within the batch, and across BatchInformation8 objects will create a union. This is useful to perform bulk actions or retrieve statuses on new combinations of financing validation requests not previously associated together.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Request Body schema: application/json
required
Array of objects
submitting_financial_institution_identification
required
string <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

Responses

Request samples

Content type
application/json
Example
{
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "statuses_batch": [
    ]
}

Response samples

Content type
application/json
{
  • "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}

Get Transactions By Request ID.

Retrieves financing validation request registration and financing status details at the validation service.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
path Parameters
request-identification
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Used to retrieve the statuses of previous registrations, financings and status requests.

UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time.
In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example: 123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx"

query Parameters
offset
integer >= 0
Default: 0
Example: offset=20

Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry.

limit
integer >= 1
Example: limit=20

The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit.

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "links": [],
  • "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
  • "submitting_financial_institution_identification": "string",
  • "creation_date_time": "string",
  • "financing_validation_data_set_details": [
    ]
}

Search Transactions With Filters.

Alternative method to retrieve a filtered list of financing validation requests belonging to the calling entity as a financier, useful for graphical user interfaces.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
query Parameters
offset
integer >= 0
Default: 0
Example: offset=20

Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry.

limit
integer >= 1
Example: limit=20

The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit.

after
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...
Example: after=2021-03-29T11:00:23.000Z

Timestamp after which financing validation requests have been created

before
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...
Example: before=2021-03-29T11:00:23.000Z

Timestamp before which financing validation requests have been created. Default is current time

financed-currency
string^[A-Z]{3,3}$

ISO 4217 Currency code filter

financing-beneficiary-name
string <= 70 characters

Financing beneficiary name filter

collateral-type
string
Enum: "TREC" "OTGI" "CASH"

Collateral type filter

pre-shipment-financing
boolean

Pre-shipment financing filter

with-recourse
boolean

With recourse filter

financing-request-status
string
Enum: "REDU" "REGU" "DFIN" "FNCD" "CANC" "BATD"

Financing request status filter

duplicate-match-type
string
Enum: "EXCT" "PART"

Duplicate match filter (exact or partial)

duplicate-matches
boolean

Duplicate match filter (one or more of any type)

pool-identification
string <= 35 characters
Example: pool-identification=pool-1234

Pool identification that is sent when a pool is created

data-set-identification
string
Example: data-set-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9

Fvr identification generated by SFA server

batch-identification
string
Example: batch-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9

Batch identification generated by the SFA server for an fvr request

request-identification
string
Example: request-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9

Request identification given by the SFA server after the creation of an fvr or a financing request

submitter-batch-identification
string <= 35 characters

Submitter batch identification

submitter-data-set-identification
string <= 35 characters

Submitter data set identification

submitter-document-identification
string <= 35 characters

Submitter document identification

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "links": [],
  • "submitting_financial_institution_identification": "string",
  • "financing_validation_data_set_details": [
    ]
}

Cancel Transactions.

Requests cancellation of registration and financing of assests/transactions identified by the prvided identifications.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Request Body schema: application/json
required
Array of objects
submitting_financial_institution_identification
required
string <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

batch_booking
boolean

Indicates a "Yes" or "No" type of answer for an element.

batch_booking_override
boolean

Indicates a "Yes" or "No" type of answer for an element.

Responses

Request samples

Content type
application/json
Example
{
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "cancellation_batch": [
    ]
}

Response samples

Content type
application/json
{
  • "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000"
}

Search Document Matches.

Retrieves a filtered list of document match details involving the calling entity as financier, conforming the query parameters.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
query Parameters
offset
integer >= 0
Default: 0
Example: offset=20

Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry.

limit
integer >= 1
Example: limit=20

The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit.

after
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...
Example: after=2021-03-29T11:00:23.000Z

Timestamp after which matches have been identified. Default is last 24h

before
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...
Example: before=2021-03-29T11:00:23.000Z

Timestamp before which matches have been identifiedDefault is current time

match-type
string
Enum: "EXCT" "PART"

Exact or Partial matches only

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "links": [],
  • "matches": [
    ]
}

Get Document Match.

Retrieves individual document match details involving the calling entity as financier.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
path Parameters
match-identification
required
string

Match identification

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
  • "match_type": "EXCT",
  • "matched_record_submitter": {
    },
  • "matched_date_time": "string",
  • "matching_report": [
    ],
  • "proprietary_matching_details": {
    },
  • "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
  • "matched_document_a": {
    },
  • "matched_document_b": {
    }
}

Get Cancellation Status.

Retrieves cancellation status of receivables at the validation service.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
path Parameters
cancellation-identification
required
string <uuid>
Example: 789e4567-e89b-12d3-a456-426614174000

Note: Will be filled in by the server, not by the submitter.

UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time.

In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens).

For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx"

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000",
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "cancellation_status_batch": [
    ]
}

HealthCheck

Internal Service Health Check endpoints

Service health check.

Endpoint for service health check.

Authorizations:
oAuth2ClientCredentialsoAuth2Password

Responses

Response samples

Content type
application/json
"OK"

Notifications

Notification endpoints to poll for new results activity

Get Activity.

Endpoint to provide list of activity relating to new results to avoid polling individual datasets independently.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
query Parameters
offset
integer >= 0
Default: 0
Example: offset=20

Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry.

limit
integer >= 1
Example: limit=20

The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit.

after
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...
Example: after=2021-03-29T11:00:23.000Z

Timestamp after which to search for events (exclusive). Default is last 24h

before
string^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])...
Example: before=2021-03-29T11:00:23.000Z

Timestamp before which to search for events (inclusive). Default is current time

data_set_identification
string
Example: data_set_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9

fvr identification

batch_identification
string
Example: batch_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9

batch identification coming from an fvr request

request_identification
string
Example: request_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9

request identification given by the server after the creation of an fvr or a financing request

pool_identification
string
Example: pool_identification=pool-1234

pool identification that is sent when a pool is created

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
Example
{}

DocumentAuthentication

Endpoints for managing Document Authentication processes (Genuiness Validation) against Trade Utility Services

Create Trade Utility Account.

Sets up trade utility account owner data (without financings input) at the validation service, linked to a financier.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Request Body schema: application/json
submitting_financial_institution_identification
required
string <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

required
object

Specifies the identification of an organisation.

Array of objects
Array of objects
Example: "[object Object]"

Responses

Request samples

Content type
application/json
{
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "trade_utility_account_holder_identification": {
    },
  • "trade_utility_account_holder_contacts": [
    ],
  • "trade_utility_credential_requests": [
    ]
}

Response samples

Content type
application/json
{
  • "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}

Edit Trade Utility Account.

Edits trade utility account owner data (without financings input) at the validation service, linked to a financier.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
path Parameters
account-identification
required
string <uuid>
Example: 456e4567-e89b-12d3-a456-426614174000

Note: Will be filled in by the server, not by the submitter.

UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time.

In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens).

For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx"

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Request Body schema: application/json
submitting_financial_institution_identification
required
string <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

required
object

Specifies the identification of an organisation.

Array of objects
Array of objects
Example: "[object Object]"

Responses

Request samples

Content type
application/json
{
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "trade_utility_account_holder_identification": {
    },
  • "trade_utility_credential_requests": [
    ]
}

Response samples

Content type
application/json
{
  • "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}

Get Trade Utility Account.

Retrieves trade utility account owner setup data at the validation service.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
path Parameters
account-identification
required
string <uuid>
Example: 456e4567-e89b-12d3-a456-426614174000

Note: Will be filled in by the server, not by the submitter.

UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time.

In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens).

For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx"

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "submitting_financial_institution_identification": "SWHQBEBBXXX",
  • "trade_utility_account_holder_identification": {
    },
  • "trade_utility_account_holder_contacts": [
    ],
  • "trade_utility_credential_requests": [
    ],
  • "account_identification": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "account_setup_status": "COMP",
  • "account_owner_consent_email_address": "info@acmeap.com",
  • "trade_utility_consent": [
    ]
}

Get Raw Document Validation Data.

Retrieves full raw trade utility data for a specific document authentication request which completed.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
path Parameters
trade-utility-data-identification
required
string

trade_utility_data_identification from the trade_utility_data object given in the GET /status/{request-identification} endpoint result

header Parameters
X-UserContext
string
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-

Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.

Responses

Response samples

Content type
application/json
{
  • "trade_utility_data_identification": "aa69fd4c-7674-484f-aa57-70ae72ea02b7",
  • "business_service": "DHLT_dhl_shipment_tracking",
  • "record_identifier": "125-12345678",
  • "current_status_date_time": "2021-05-03T12:03:00.000Z",
  • "data": "{\\\"url\\\":\\\"\\/shipments?trackingNumber=12512345678?offset=0&limit=5\\\",\\\"prevUrl\\\":\\\"\\/shipments?trackingNumber=7777777770?offset=0&limit=5\\\",\\\"nextUrl\\\":\\\"\\/shipments?trackingNumber=7777777770?offset=5&limit=5\\\",\\\"firstUrl\\\":\\\"\\/shipments?trackingNumber=7777777770?offset=0&limit=5\\\",\\\"lastUrl\\\":\\\"\\/shipments?trackingNumber=7777777770?offset=10&limit=5\\\",\\\"shipments\\\":[{\\\"id\\\":\\\"7777777770\\\",\\\"service\\\":\\\"express\\\",\\\"origin\\\":{\\\"address\\\":{\\\"countryCode\\\":\\\"NL\\\",\\\"postalCode\\\":\\\"1043 AG\\\",\\\"addressLocality\\\":\\\"Oderweg 2, AMSTERDAM\\\"}},\\\"destination\\\":{\\\"address\\\":{\\\"countryCode\\\":\\\"NL\\\",\\\"postalCode\\\":\\\"1043 AG\\\",\\\"addressLocality\\\":\\\"Oderweg 2, AMSTERDAM\\\"}},\\\"status\\\":{\\\"timestamp\\\":\\\"2018-03-02T07:53:47Z\\\",\\\"location\\\":{\\\"address\\\":{\\\"countryCode\\\":\\\"NL\\\",\\\"postalCode\\\":\\\"1043 AG\\\",\\\"addressLocality\\\":\\\"Oderweg 2, AMSTERDAM\\\"}},\\\"statusCode\\\":\\\"pre-transit\\\",\\\"status\\\":\\\"DELIVERED\\\",\\\"description\\\":\\\"JESSICA\\\",\\\"remark\\\":\\\"The shipment is pending completion of customs inspection.\\\",\\\"nextSteps\\\":\\\"The status will be updated following customs inspection.\\\"},\\\"estimatedTimeOfDelivery\\\":\\\"2018-08-03T00:00:00Z\\\",\\\"estimatedDeliveryTimeFrame\\\":{\\\"estimatedFrom\\\":\\\"2018-08-03T00:00:00Z\\\",\\\"estimatedThrough\\\":\\\"2018-08-03T22:00:00Z\\\"},\\\"estimatedTimeOfDeliveryRemark\\\":\\\"By End of Day\\\",\\\"serviceUrl\\\":\\\"http:\\/\\/www.dhl.de\\/de\\/privatkunden.html?piececode=7777777770\\\",\\\"rerouteUrl\\\":\\\"https:\\/\\/www.dhl.de\\/de\\/privatkunden.html?piececode=7777777770&verfuegen_selected_tab=FIRST\\\",\\\"details\\\":{\\\"carrier\\\":{\\\"@type\\\":\\\"Organization\\\",\\\"organizationName\\\":\\\"EXPRESS\\\"},\\\"product\\\":{\\\"productName\\\":\\\"UNKNOWN - Product unknown\\\"},\\\"receiver\\\":{\\\"@type\\\":\\\"Person\\\",\\\"organizationName\\\":\\\"EXPRESS\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"givenName\\\":\\\"John\\\",\\\"name\\\":\\\"John\\\"},\\\"sender\\\":{\\\"@type\\\":\\\"Person\\\",\\\"organizationName\\\":\\\"EXPRESS\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"givenName\\\":\\\"John\\\",\\\"name\\\":\\\"John\\\"},\\\"proofOfDelivery\\\":{\\\"timestamp\\\":\\\"2018-09-05T16:33:00Z\\\",\\\"signatureUrl\\\":\\\"string\\\",\\\"documentUrl\\\":\\\"https:\\/\\/webpod.dhl.com\\/webPOD\\/DHLePODRequest\\\",\\\"signed\\\":{\\\"@type\\\":\\\"Person\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"givenName\\\":\\\"John\\\",\\\"name\\\":\\\"John\\\"}},\\\"totalNumberOfPieces\\\":8,\\\"pieceIds\\\":[\\\"JD014600006281230704\\\",\\\"JD014600002708681600\\\",\\\"JD014600006615052259\\\",\\\"JD014600006615052264\\\",\\\"JD014600006615052265\\\",\\\"JD014600006615052268\\\",\\\"JD014600006615052307\\\",\\\"JD014600002266382340\\\",\\\"JD014600002659593446\\\",\\\"JD014600006101653481\\\",\\\"JD014600006614884499\\\"],\\\"weight\\\":{\\\"value\\\":253.5,\\\"unitText\\\":\\\"kg\\\"},\\\"volume\\\":{\\\"value\\\":12600},\\\"loadingMeters\\\":1.5,\\\"dimensions\\\":{\\\"width\\\":{\\\"value\\\":20,\\\"unitText\\\":\\\"cm\\\"},\\\"height\\\":{\\\"value\\\":18,\\\"unitText\\\":\\\"cm\\\"},\\\"length\\\":{\\\"value\\\":35,\\\"unitText\\\":\\\"cm\\\"}},\\\"references\\\":{\\\"number\\\":\\\"YZ3892406173\\\",\\\"type\\\":\\\"customer-reference\\\"},\\\"dgf:routes\\\":[{\\\"dgf:vesselName\\\":\\\"MAERSK SARAT\\\",\\\"dgf:voyageFlightNumber\\\":\\\"TR TRUCK\\\",\\\"dgf:airportOfDeparture\\\":{\\\"dgf:locationName\\\":\\\"GOTHENBURG\\\",\\\"dgf:locationCode\\\":\\\"AMS\\\",\\\"countryCode\\\":\\\"NL\\\"},\\\"dgf:airportOfDestination\\\":{\\\"dgf:locationName\\\":\\\"GOTHENBURG\\\",\\\"dgf:locationCode\\\":\\\"AMS\\\",\\\"countryCode\\\":\\\"NL\\\"},\\\"dgf:estimatedDepartureDate\\\":\\\"2017-10-10T09:00:00\\\",\\\"dgf:estimatedArrivalDate\\\":\\\"2017-20-10T09:00:00\\\",\\\"dgf:placeOfAcceptance\\\":{\\\"dgf:locationName\\\":\\\"GOTHENBURG\\\"},\\\"dgf:portOfLoading\\\":{\\\"dgf:locationName\\\":\\\"GOTHENBURG\\\"},\\\"dgf:portOfUnloading\\\":{\\\"dgf:locationName\\\":\\\"GOTHENBURG\\\"},\\\"dgf:placeOfDelivery\\\":{\\\"dgf:locationName\\\":\\\"GOTHENBURG\\\"}}]},\\\"events\\\":[{\\\"timestamp\\\":\\\"2018-03-02T07:53:47Z\\\",\\\"location\\\":{\\\"address\\\":{\\\"countryCode\\\":\\\"NL\\\",\\\"postalCode\\\":\\\"1043 AG\\\",\\\"addressLocality\\\":\\\"Oderweg 2, AMSTERDAM\\\"}},\\\"statusCode\\\":\\\"pre-transit\\\",\\\"status\\\":\\\"DELIVERED\\\",\\\"description\\\":\\\"JESSICA\\\",\\\"remark\\\":\\\"The shipment is pending completion of customs inspection.\\\",\\\"nextSteps\\\":\\\"The status will be updated following customs inspection.\\\"}]}],\\\"possibleAdditionalShipmentsUrl\\\":[\\\"\\/shipments?trackingNumber=7777777770&service=parcel-de\\\",\\\"\\/shipments?trackingNumber=7777777770&service=parcel-nl\\\"]}"
}