docs.securefinancing.com
Open in
urlscan Pro
76.76.21.123
Public Scan
URL:
https://docs.securefinancing.com/
Submission: On August 04 via automatic, source certstream-suspicious — Scanned from DE
Submission: On August 04 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* GSF Trade Financing Validation API
* 1. Introduction
* 💡 Solution Overview
* 🔎 FAQs
* 📬 Support
* 2. API User Guide
* Getting Started
* Registrations
* Retrieving Results
* Financings
* Cancellations
* Monitoring Activity and Polling
* Analyzing Results and Matches
* Glossary
* APIS
* TradeFinancingValidationService
* postRegister Transactions.
* postMark as Financed.
* postCreate New Set.
* getGet Transactions By Request ID.
* getSearch Transactions With Filters.
* postCancel Transactions.
* getSearch Document Matches.
* getGet Document Match.
* getGet Cancellation Status.
* HealthCheck
* getService health check.
* Notifications
* getGet Activity.
* DocumentAuthentication
* postCreate Trade Utility Account.
* patchEdit Trade Utility Account.
* getGet Trade Utility Account.
* getGet Raw Document Validation Data.
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.
post/registrations
Live environment
https://api.securefinancing.com/v1/registrations
Customer Test environment
https://api.uat.securefinancing.com/v1/registrations
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
batch_collection
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])...Show pattern
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]...Show
pattern
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
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "pool_identification": "string",
* "creation_date_time": "string",
* "submitting_financial_institution_identification": "string",
* "batch_collection": [
* {
* "submitter_batch_identification": "string",
* "data_set_validation_service": "REGI",
* "batch_booking": true,
* "financing_validation_request_details": [
* {
* "submitter_data_set_identification": "string",
* "financing_applicant": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": null,
* "proprietary": null
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "collateral_type": "TREC",
* "pre_shipment_financing": true,
* "with_recourse": true,
* "financing_request_amount": {
* "currency": "string",
* "amount": "string"
},
* "referred_documents": [
* {
* "submitter_document_reference": "string",
* "country_of_issue": "string",
* "trade_utility_service": [
* {
* "service_name": "LLI_VALIDATION",
* "record_identifier": "string",
* "record_owner_identification": "string",
* "record_owner_contact_emails": [
* null
]
}
],
* "document_summary": {
* "document_type": "CINV",
* "document_issuer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "issue_date": "string",
* "seller_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "buyer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "invoice_number": "string",
* "total_invoice_amount": {
* "currency": "string",
* "amount": "string"
},
* "commercial_line_items": [
* {
* "line_item_identification": null,
* "quantity": null,
* "unit_price": null,
* "product_name": null,
* "product_identifier": null
}
],
* "ship_to_name": "string",
* "ship_to_address_line": [
* "string"
],
* "ship_to_country": "string",
* "payment_method": "CHK"
}
}
]
}
]
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
MARK AS FINANCED.
post/financings
Live environment
https://api.securefinancing.com/v1/financings
Customer Test environment
https://api.uat.securefinancing.com/v1/financings
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
financing_batch
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]...Show
pattern
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
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Example
financings_example1financings_example2financings_example3financings_example4financings_example1
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "financing_batch": [
* {
* "pool_identification": "AZN20200110"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
CREATE NEW SET.
post/status-requests
Live environment
https://api.securefinancing.com/v1/status-requests
Customer Test environment
https://api.uat.securefinancing.com/v1/status-requests
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
statuses_batch
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]...Show
pattern
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
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Example
status_example1status_example2status_example3status_example4status_example1
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "statuses_batch": [
* {
* "pool_identification": "AZN20200110"
},
* {
* "pool_identification": "AZN20200111"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
GET TRANSACTIONS BY REQUEST ID.
get/status/{request-identification}
Live environment
https://api.securefinancing.com/v1/status/{request-identification}
Customer Test environment
https://api.uat.securefinancing.com/v1/status/{request-identification}
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
* "submitting_financial_institution_identification": "string",
* "creation_date_time": "string",
* "financing_validation_data_set_details": [
* {
* "pool_identification": "string",
* "submitter_batch_identification": "string",
* "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "batch_booking": true,
* "submitter_data_set_identification": "string",
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "data_set_validation_service": "REGI",
* "financing_applicant": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "financed_amount": {
* "currency": "string",
* "amount": "string"
},
* "collateral_type": "TREC",
* "pre_shipment_financing": true,
* "with_recourse": true,
* "referred_documents": [
* {
* "submitter_document_reference": "string",
* "country_of_issue": "string",
* "trade_utility_service": [
* {
* "service_name": "LLI_VALIDATION",
* "record_identifier": "string",
* "record_owner_identification": "string",
* "record_owner_contact_emails": [
* "string"
]
}
],
* "document_summary": {
* "document_type": "CINV",
* "document_issuer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "issue_date": "string",
* "seller_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "buyer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "invoice_number": "string",
* "total_invoice_amount": {
* "currency": "string",
* "amount": "string"
},
* "commercial_line_items": [
* {
* "line_item_identification": "string",
* "quantity": {
* "unit_of_measure": {
* "unit_of_measure_code": null,
* "other_unit_of_measure": null
},
* "value": "string",
* "factor": "string"
},
* "unit_price": {
* "currency": "string",
* "amount": "string"
},
* "product_name": "string",
* "product_identifier": {
* "structured_product_identifier": {
* "type": null,
* "identifier": null
},
* "other_product_identifier": {
* "identification": null,
* "identification_type": null
}
}
}
],
* "ship_to_name": "string",
* "ship_to_address_line": [
* "string"
],
* "ship_to_country": "string",
* "payment_method": "CHK"
},
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "trade_utility_matching": [
* {
* "business_service": "GSTN_goods_and_services_tax_network",
* "current_status_date_time":
"2020-01-10T16:29:20.000+00:00",
* "validation_status": "VALD",
* "matching_report": [
* {
* "element_name": "invoice_number",
* "matching_status": "MACH"
}
]
}
],
* "trade_utility_data": [
* {
* "business_service": "LLI_VALIDATION",
* "current_status_date_time": "string",
* "trade_utility_data_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
],
* "document_duplicate_matches": {
* "exact_matches": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
],
* "partial_matches": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
}
],
* "financing_request_status": "DFIN",
* "financing_request_duplicate_report": [
* {
* "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "match_type": "EXCT",
* "matched_financing_request_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": null,
* "proprietary": null
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "matched_financing_request_status": "DFIN",
* "matched_financing_request_amount": {
* "currency": "string",
* "amount": "string"
},
* "financing_applicant_is_matched": true,
* "matched_date_time": "string",
* "proprietary_matching_details": {
* "proprietary_description": "string",
* "proprietary_classifier_result_description": "string",
* "proprietary_classifier_result_identification": "string"
},
* "related_document_match_identifications": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
],
* "errors": [
* {
* "type": "https://example.com/probs/out-of-credit",
* "title": "You do not have enough credit.",
* "status": "405",
* "detail": "Your current balance is 30, but that costs 50",
* "instance": "/account/12345/",
* "error": "655617",
* "path": "/api/book/1",
* "timestamp": "2020-08-06T14:16:27.520Z"
}
]
}
]
}
SEARCH TRANSACTIONS WITH FILTERS.
get/financing-validation-requests
Live environment
https://api.securefinancing.com/v1/financing-validation-requests
Customer Test environment
https://api.uat.securefinancing.com/v1/financing-validation-requests
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])...Show pattern
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])...Show pattern
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "submitting_financial_institution_identification": "string",
* "financing_validation_data_set_details": [
* {
* "pool_identification": "string",
* "submitter_batch_identification": "string",
* "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "batch_booking": true,
* "submitter_data_set_identification": "string",
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "data_set_validation_service": "REGI",
* "financing_applicant": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "financed_amount": {
* "currency": "string",
* "amount": "string"
},
* "collateral_type": "TREC",
* "pre_shipment_financing": true,
* "with_recourse": true,
* "referred_documents": [
* {
* "submitter_document_reference": "string",
* "country_of_issue": "string",
* "trade_utility_service": [
* {
* "service_name": "LLI_VALIDATION",
* "record_identifier": "string",
* "record_owner_identification": "string",
* "record_owner_contact_emails": [
* "string"
]
}
],
* "document_summary": {
* "document_type": "CINV",
* "document_issuer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "issue_date": "string",
* "seller_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "buyer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "invoice_number": "string",
* "total_invoice_amount": {
* "currency": "string",
* "amount": "string"
},
* "commercial_line_items": [
* {
* "line_item_identification": "string",
* "quantity": {
* "unit_of_measure": {
* "unit_of_measure_code": null,
* "other_unit_of_measure": null
},
* "value": "string",
* "factor": "string"
},
* "unit_price": {
* "currency": "string",
* "amount": "string"
},
* "product_name": "string",
* "product_identifier": {
* "structured_product_identifier": {
* "type": null,
* "identifier": null
},
* "other_product_identifier": {
* "identification": null,
* "identification_type": null
}
}
}
],
* "ship_to_name": "string",
* "ship_to_address_line": [
* "string"
],
* "ship_to_country": "string",
* "payment_method": "CHK"
},
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "trade_utility_matching": [
* {
* "business_service": "GSTN_goods_and_services_tax_network",
* "current_status_date_time":
"2020-01-10T16:29:20.000+00:00",
* "validation_status": "VALD",
* "matching_report": [
* {
* "element_name": "invoice_number",
* "matching_status": "MACH"
}
]
}
],
* "trade_utility_data": [
* {
* "business_service": "LLI_VALIDATION",
* "current_status_date_time": "string",
* "trade_utility_data_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
],
* "document_duplicate_matches": {
* "exact_matches": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
],
* "partial_matches": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
}
],
* "financing_request_status": "DFIN",
* "financing_request_duplicate_report": [
* {
* "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "match_type": "EXCT",
* "matched_financing_request_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": null,
* "proprietary": null
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "matched_financing_request_status": "DFIN",
* "matched_financing_request_amount": {
* "currency": "string",
* "amount": "string"
},
* "financing_applicant_is_matched": true,
* "matched_date_time": "string",
* "proprietary_matching_details": {
* "proprietary_description": "string",
* "proprietary_classifier_result_description": "string",
* "proprietary_classifier_result_identification": "string"
},
* "related_document_match_identifications": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
],
* "errors": [
* {
* "type": "https://example.com/probs/out-of-credit",
* "title": "You do not have enough credit.",
* "status": "405",
* "detail": "Your current balance is 30, but that costs 50",
* "instance": "/account/12345/",
* "error": "655617",
* "path": "/api/book/1",
* "timestamp": "2020-08-06T14:16:27.520Z"
}
]
}
]
}
CANCEL TRANSACTIONS.
post/cancellations
Live environment
https://api.securefinancing.com/v1/cancellations
Customer Test environment
https://api.uat.securefinancing.com/v1/cancellations
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
cancellation_batch
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]...Show
pattern
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
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Example
cancellation_example1cancellation_example2cancellation_example1
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "cancellation_batch": [
* {
* "pool_identification": "AZN20200110",
* "cancellation_reason": "EXNB"
},
* {
* "batch_identification": "7a3ef62c-6e80-497f-8831-f4a809ef6344",
* "cancellation_reason": "EXNB"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000"
}
SEARCH DOCUMENT MATCHES.
get/document-matches
Live environment
https://api.securefinancing.com/v1/document-matches
Customer Test environment
https://api.uat.securefinancing.com/v1/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])...Show pattern
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])...Show pattern
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "matches": [
* {
* "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "match_type": "EXCT",
* "matched_record_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "matched_date_time": "string",
* "matching_report": [
* {
* "element_name": "InvoiceNumber",
* "matching_status": "MACH"
}
],
* "proprietary_matching_details": {
* "proprietary_description": "string",
* "proprietary_classifier_result_description": "string",
* "proprietary_classifier_result_identification": "string"
},
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_document_a": {
* "financing_request_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
},
* "matched_document_b": {
* "financing_request_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
}
]
}
GET DOCUMENT MATCH.
get/document-matches/{match-identification}
Live environment
https://api.securefinancing.com/v1/document-matches/{match-identification}
Customer Test environment
https://api.uat.securefinancing.com/v1/document-matches/{match-identification}
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "match_type": "EXCT",
* "matched_record_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "matched_date_time": "string",
* "matching_report": [
* {
* "element_name": "InvoiceNumber",
* "matching_status": "MACH"
}
],
* "proprietary_matching_details": {
* "proprietary_description": "string",
* "proprietary_classifier_result_description": "string",
* "proprietary_classifier_result_identification": "string"
},
* "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_document_a": {
* "financing_request_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
},
* "matched_document_b": {
* "financing_request_submitter": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": "string",
* "scheme_name": {
* "code": "stri",
* "proprietary": "string"
},
* "issuer": "string"
}
]
},
* "country_of_domicile": "string"
},
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
}
GET CANCELLATION STATUS.
get/cancellations/{cancellation-identification}/status
Live environment
https://api.securefinancing.com/v1/cancellations/{cancellation-identification}/status
Customer Test environment
https://api.uat.securefinancing.com/v1/cancellations/{cancellation-identification}/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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000",
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "cancellation_status_batch": [
* {
* "pool_identification": "pool123",
* "batch_identification": "509a858d-e6d4-496b-9543-5244ab44b271",
* "data_set_identification": "7a3ef62c-6e80-497f-8831-f4a809ef6344",
* "submitter_data_set_identification": "submitterdatasetid123",
* "cancellation_reason": "EXNB",
* "cancellation_status": "PACK"
}
]
}
HEALTHCHECK
Internal Service Health Check endpoints
SERVICE HEALTH CHECK.
get/health-check
Live environment
https://api.securefinancing.com/v1/health-check
Customer Test environment
https://api.uat.securefinancing.com/v1/health-check
Endpoint for service health check.
AUTHORIZATIONS:
oAuth2ClientCredentialsoAuth2Password
RESPONSES
200
Service OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
"OK"
NOTIFICATIONS
Notification endpoints to poll for new results activity
GET ACTIVITY.
get/activity
Live environment
https://api.securefinancing.com/v1/activity
Customer Test environment
https://api.uat.securefinancing.com/v1/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])...Show pattern
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])...Show pattern
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Example
activity_uniqueactivity_cancel_successactivity_cancel_rejectedactivity_redu_to_dfin_as_bank_a_processes_financingactivity_register_high_risk_duplicate_after_bank_aactivity_unique
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.securefinancing.com/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "events": [
* {
* "event_identification": "3b9e9c6f-3de1-41b9-9f8f-f911174d426f",
* "event_date_time": "2023-01-10T11:01:43.000Z",
* "pool_identification": "POOL-1234",
* "submitter_batch_identification": "BATCH-1234",
* "batch_identification": "b56cfee7-1a0a-49ba-9260-aeff4fd537c7",
* "submitter_data_set_identification": "FIN-1234",
* "data_set_identification": "8ecef726-f12e-40b9-9722-8878a8d33bc5",
* "request_identifications": [
* "9ef2ee9c-a2b7-49bc-a5a9-ef65b4972eab"
],
* "event_details": [
* {
* "service_name": "FINANCING_REQUEST_STATUS",
* "status": "REGU"
}
]
}
]
}
DOCUMENTAUTHENTICATION
Endpoints for managing Document Authentication processes (Genuiness Validation)
against Trade Utility Services
CREATE TRADE UTILITY ACCOUNT.
post/trade-utility-accounts
Live environment
https://api.securefinancing.com/v1/trade-utility-accounts
Customer Test environment
https://api.uat.securefinancing.com/v1/trade-utility-accounts
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]...Show
pattern
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".
trade_utility_account_holder_identification
required
object
Specifies the identification of an organisation.
trade_utility_account_holder_contacts
Array of objects
trade_utility_credential_requests
Array of objects
Example: "[object Object]"
RESPONSES
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "trade_utility_account_holder_identification": {
* "name": "Acme Asia Pacific Ltd",
* "identifications": {
* "lei": "123400JDHEY32UDW2W16",
* "email_address": "info@acmeap.com",
* "other": [
* {
* "identification": "202016178R",
* "scheme_name": {
* "code": "UEN",
* "proprietary": "Unique Entity Number"
},
* "issuer": "Singapore Government"
}
]
},
* "country_of_domicile": "SG"
},
* "trade_utility_account_holder_contacts": [
* {
* "email_address": "info@acmeap.com"
}
],
* "trade_utility_credential_requests": [
* {
* "business_service": "DHLT_dhl_shipment_tracking"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}
EDIT TRADE UTILITY ACCOUNT.
patch/trade-utility-accounts/{account-identification}
Live environment
https://api.securefinancing.com/v1/trade-utility-accounts/{account-identification}
Customer Test environment
https://api.uat.securefinancing.com/v1/trade-utility-accounts/{account-identification}
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]...Show
pattern
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".
trade_utility_account_holder_identification
required
object
Specifies the identification of an organisation.
trade_utility_account_holder_contacts
Array of objects
trade_utility_credential_requests
Array of objects
Example: "[object Object]"
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "trade_utility_account_holder_identification": {
* "name": "Acme Asia Pacific Ltd",
* "identifications": {
* "lei": "123400JDHEY32UDW2W16",
* "email_address": "info@acmeap.com",
* "other": [
* {
* "identification": "202016178R",
* "scheme_name": {
* "code": "UEN",
* "proprietary": "Unique Entity Number"
},
* "issuer": "Singapore Government"
}
]
},
* "country_of_domicile": "SG"
},
* "trade_utility_credential_requests": [
* {
* "business_service": "DHLT_dhl_shipment_tracking"
},
* {
* "business_service": "GSTN_goods_and_services_tax_network"
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}
GET TRADE UTILITY ACCOUNT.
get/trade-utility-accounts/{account-identification}/status
Live environment
https://api.securefinancing.com/v1/trade-utility-accounts/{account-identification}/status
Customer Test environment
https://api.uat.securefinancing.com/v1/trade-utility-accounts/{account-identification}/status
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification": "SWHQBEBBXXX",
* "trade_utility_account_holder_identification": {
* "name": "Acme Asia Pacific Ltd",
* "identifications": {
* "lei": "123400JDHEY32UDW2W16",
* "email_address": "info@acmeap.com",
* "other": [
* {
* "identification": "202016178R",
* "scheme_name": {
* "code": "UEN",
* "proprietary": "Unique Entity Number"
},
* "issuer": "Singapore Government"
}
]
},
* "country_of_domicile": "SG"
},
* "trade_utility_account_holder_contacts": [
* {
* "email_address": "info@acmeap.com"
}
],
* "trade_utility_credential_requests": [
* {
* "business_service": "DHLT_dhl_shipment_tracking",
* "credential_flag": true
}
],
* "account_identification": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
* "account_setup_status": "COMP",
* "account_owner_consent_email_address": "info@acmeap.com",
* "trade_utility_consent": [
* {
* "business_service": "DHLT_dhl_shipment_tracking",
* "consent": true,
* "mandate_start_date_time": "2021-05-03T13:50:22.002Z",
* "mandate_validity": "LTAL",
* "mandate_end_date_time": "2022-05-03T13:50:22.002Z"
}
]
}
GET RAW DOCUMENT VALIDATION DATA.
get/trade-utility-data/{trade-utility-data-identification}
Live environment
https://api.securefinancing.com/v1/trade-utility-data/{trade-utility-data-identification}
Customer Test environment
https://api.uat.securefinancing.com/v1/trade-utility-data/{trade-utility-data-identification}
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
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
502
Bad Gateway
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 415
* 429
* 500
* 502
* 503
* 504
* default
Content type
application/json
Copy
{
* "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\\\"]}"
}