TradeFinancingValidation (5.3.7)

Download OpenAPI specification:

Service for trade financing validation, fingerprinting and matching

TradeFinancingValidationService

APIs 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
pool_identification
string (Max35Text) [ 1 .. 35 ] characters

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

submitting_financial_institution_identification
string (BicOrUuidIdentifier) <= 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
Array of objects (BatchInformation3)

Responses

Request samples

Content type
application/json
{
  • "pool_identification": "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
submitting_financial_institution_identification
required
string (BicOrUuidIdentifier) <= 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 (YesNoIndicator)

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

batch_booking_override
boolean (YesNoIndicator)

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

required
Array of objects (BatchInformation5)

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"
}

Get Transactions By Request ID

The response includes pagination metadata for financing validation requests registered under the specified request-identification. include-cancelled applies to the returned result set. include-fvrs-with-similarity and include-similarity do not affect filtering or the pagination count.

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.

include-cancelled
boolean
Example: include-cancelled=true

Include or exclude cancelled FVRs and their matches (defaults to include)

include-similarity
MatchSimilarity
Deprecated
Example: include-similarity=CRITICAL_SIMILARITY

Only include matches of a specific similarity levels

include-matches-with-similarity
MatchSimilarity
Example: include-matches-with-similarity=CRITICAL_SIMILARITY

Only include duplicate reports for matches of specific similarity levels

include-fvrs-with-similarity
MatchSimilarity
Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY

Only include FVRs that have matches of specific similarity levels

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": [],
  • "pagination": {
    },
  • "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
  • "submitting_financial_institution_identification": "string",
  • "creation_date_time": "string",
  • "financing_validation_data_set_details": [
    ]
}

Get Transactions By Request ID (metadata only)

Returns a metadata-only subset of /status/{request-identification} using the same filtering and pagination semantics. include-fvrs-with-similarity and include-similarity do not affect filtering or the pagination count.

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.

include-cancelled
boolean
Example: include-cancelled=true

Include or exclude cancelled FVRs and their matches (defaults to include)

include-similarity
MatchSimilarity
Deprecated
Example: include-similarity=CRITICAL_SIMILARITY

Only include matches of a specific similarity levels

include-matches-with-similarity
MatchSimilarity
Example: include-matches-with-similarity=CRITICAL_SIMILARITY

Only include duplicate reports for matches of specific similarity levels

include-fvrs-with-similarity
MatchSimilarity
Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY

Only include FVRs that have matches of specific similarity levels

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": [],
  • "pagination": {
    },
  • "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

The response includes pagination metadata for financing validation requests that match the query filters. include-cancelled does not change which requests return; it only controls whether cancelled duplicate matches appear in each result's duplicate report.

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.

sort
string
Example: sort=-created_timestamp,submitter_data_set_id

Field(s) to sort by, separated by commas. Optionally, a leading + or - to determined ascending or descending sort order.

after
string (ISODateTime) ^(-?(?:[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 (ISODateTime) ^(-?(?:[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

include-cancelled
boolean
Example: include-cancelled=true

Include or exclude cancelled FVRs and their matches (defaults to include)

include-similarity
MatchSimilarity
Deprecated
Example: include-similarity=CRITICAL_SIMILARITY

Only include matches of a specific similarity levels

include-matches-with-similarity
MatchSimilarity
Example: include-matches-with-similarity=CRITICAL_SIMILARITY

Only include duplicate reports for matches of specific similarity levels

include-fvrs-with-similarity
MatchSimilarity
Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY

Only include FVRs that have matches of specific similarity levels

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": [],
  • "pagination": {
    },
  • "submitting_financial_institution_identification": "string",
  • "financing_validation_data_set_details": [
    ]
}

Search Transactions With Filters (metadata only)

Returns a metadata-only subset of /financing-validation-requests using the same filtering and pagination semantics for cases where full detail is unnecessary.

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.

sort
string
Example: sort=-created_timestamp,submitter_data_set_id

Field(s) to sort by, separated by commas. Optionally, a leading + or - to determined ascending or descending sort order.

after
string (ISODateTime) ^(-?(?:[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 (ISODateTime) ^(-?(?:[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

include-cancelled
boolean
Example: include-cancelled=true

Include or exclude cancelled FVRs and their matches (defaults to include)

include-similarity
MatchSimilarity
Deprecated
Example: include-similarity=CRITICAL_SIMILARITY

Only include matches of a specific similarity levels

include-matches-with-similarity
MatchSimilarity
Example: include-matches-with-similarity=CRITICAL_SIMILARITY

Only include duplicate reports for matches of specific similarity levels

include-fvrs-with-similarity
MatchSimilarity
Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY

Only include FVRs that have matches of specific similarity levels

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": [],
  • "pagination": {
    },
  • "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
submitting_financial_institution_identification
required
string (BicOrUuidIdentifier) <= 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 (YesNoIndicator)

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

batch_booking_override
boolean (YesNoIndicator)

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

required
Array of objects (BatchInformation6)

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

The response includes pagination metadata for document matches that meet the supplied filters and the calling institution's access scope.

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 (ISODateTime) ^(-?(?:[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 (ISODateTime) ^(-?(?:[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": [],
  • "pagination": {
    },
  • "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

The response includes pagination metadata for activity events that match the supplied filters, enabling clients to retrieve and process new activity results across datasets.

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 (ISODateTime) ^(-?(?:[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 (ISODateTime) ^(-?(?:[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 (Genuineness Validation) against Trade Utility Services

List Client Accounts

Retrieves all clients data at the validation service.

Authorizations:
oAuth2ClientCredentialsoAuth2Password
query Parameters
status
string
Enum: "PDNG" "EXPD" "COMP"

'Filter by status'

  • PDNG - Pending. Maps to DAS statuses REQUESTED, PENDING, and NOT_GIVEN.
  • EXPD - Expired. Maps to DAS statuses LINK_EXPIRED and EXPIRED.
  • COMP - Completed. Maps to DAS status GIVEN.
sort
string
Example: sort=-created_timestamp,submitter_data_set_id

Field(s) to sort by, separated by commas. Optionally, a leading + or - to determined ascending or descending sort order.

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
{}

Add New Client Account

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

Authorizations:
oAuth2ClientCredentialsoAuth2Password
query Parameters
sendEmail
boolean
Default: false

When sendEmail=true, consent-link email is sent. If sendEmail is omitted or set to false, consent-link email is not sent because default value is false.

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 (BicOrUuidIdentifier) <= 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 (PartyIdentification)

Specifies the identification of an organisation.

Array of objects (ContactIdentification6)
Array of objects (TradeUtilityCredentialDetails1)

Responses

Request samples

Content type
application/json
{
  • "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
  • "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 Client Account

Edits client 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"

query Parameters
sendEmail
boolean
Default: false

When sendEmail=true, consent-link email is sent. If sendEmail is omitted or set to false, consent-link email is not sent because default value is false.

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 (BicOrUuidIdentifier) <= 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 (PartyIdentification)

Specifies the identification of an organisation.

Array of objects (ContactIdentification6)
Array of objects (TradeUtilityCredentialDetails1)

Responses

Request samples

Content type
application/json
{
  • "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
  • "trade_utility_account_holder_identification": {
    },
  • "trade_utility_credential_requests": [
    ]
}

Response samples

Content type
application/json
null

Get Client Account

Retrieves client 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
{}

Delete Client Account

Deletes client 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.

Responses

Response samples

Content type
application/json
null

Show Client Account Consent Status

Retrieves client consent status 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
{}

Update Client Credentials

Update client credentials

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-api-key
required
string

API key provided by the server for authentication against specific endpoints that cannot be supported with Auth0.

Request Body schema: application/json
business_service
required
string (TradeUtilityServiceName) [ 1 .. 70 ] characters
Enum: "LLI_VALIDATION" "GST_VALIDATION_GSTR" "GST_VALIDATION_EWAYBILL" "GST_VALIDATION_EINVOICE"

Specifies the trade utility service.

  • LLI_VALIDATION - Lloyds List Intelligence (LLI) document validation
  • GST_VALIDATION_GSTR - Goods and Services Tax (GST) document validation for Indian invoices - GSTR1 or GSTR2a filings
  • GST_VALIDATION_EWAYBILL - Goods and Services Tax (GST) document validation for Indian invoices - e-WayBill
  • GST_VALIDATION_EINVOICE - Goods and Services Tax (GST) document validation for Indian invoices - e-Invoice
credentials_data
object

Business service specific credentials

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "business_service": "GSTN_goods_and_services_tax_network"
}

Response samples

Content type
application/json
null