tfr-docs.securefinancing.com
Open in
urlscan Pro
76.76.21.123
Public Scan
URL:
https://tfr-docs.securefinancing.com/
Submission: On July 06 via automatic, source certstream-suspicious — Scanned from DE
Submission: On July 06 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* TFR Trade Financing Validation API
* 1. Introduction
* đź’ˇ Solution Overview
* 📬 Support
* 2. API User Guide
* Getting Started
* Registrations
* Retrieving Results
* Financings
* Cancellations
* Monitoring Activity and Polling
* Analyzing Results and Matches
* APIS
* TradeFinancingValidationService
* postRegister - Registers and optionally requests to finance the
assets/transactions.
* postFinance - Requests the assets/transactions to be marked as financed by
the caller.
* postNew Set - Creates a new financing validation request set definition for
subsequent status retrieval from the GET /status endpoint.
* getGet Status - Retrieves financing validation request registration and
financing status details.
* getGet Status Metadata - Retrieves financing validation request
registration and financing status details.
* getGet FVRs - Retrieve a filtered list of financing validation requests.
* getGet FVRs Metadata - Retrieve a filtered list of financing validation
requests.
* postCancel - Requests cancellation of registration and financing of
assets/transactions.
* getGet Matches - Retrieves a filtered list of document match details
involving the calling entity as financier, conforming the query parameters.
* getGet Match - Retrieves individual document match details involving the
calling entity as financier.
* getGet Cancellation - Retrieves cancellation status of receivables.
* postExtend SLA - Requests for the SLA financing decision period to be
extended by another 24h
* HealthCheck
* getEndpoint for service health check.
* Notifications
* getGet Activity - Retrieves list of latest result activity to provide
single polling endpoint.
* postActivity Callback - Receive list of latest result activity
* DocumentAuthentication
* postCreate Trade Utility Account - Sets up trade utility account owner data
for trade utilities to get consent and credentials from owner.
* patchEdit Trade Utility Account - Edits trade utility account owner data
for trade utilities to get consent and credentials from owner.
* getGet Trade Utility Account - Retrieves trade utility account owner setup
data.
* getGet Trade Utility Data - Retrieves raw trade utility data for a specific
document authentication request.
* Callbacks
* postActivity Callback - Receive list of latest result activity
API docs by Redocly
TFR TRADEFINANCINGVALIDATION (1.1.0)
Download OpenAPI specification:Download
Trade Finance Registry: support@tfr.sg URL: https://www.tfr.sg License:
Restricted
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 - REGISTERS AND OPTIONALLY REQUESTS TO FINANCE THE ASSETS/TRANSACTIONS.
Registers and optionally requests to finance the assets/transactions identified
by the provided identifications at the validation service.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRREGISTER
Example: TFRREGISTER
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
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 <uuid> (UUIDv4Identifier) = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122
"Universally Unique IDentifier (UUID) URN Namespace".
batch_collection
required
Array of objects (BatchInformation3)
RESPONSES
201
Data set registration data
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/registrations
Live environment
https://api.tfr.sg/trade-financing-validation/v1/registrations
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/registrations
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "pool_identification": "string",
* "submitting_financial_institution_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "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": "SGTRADEX_VALIDATION"
}
],
* "document_summary": {
* "document_type": "BOLD",
* "document_issuer_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "issue_date": "string",
* "shipper_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "consignee_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "carrier_identification": {
* "name": "string",
* "identifications": {
* "any_bic": null,
* "lei": null,
* "email_address": null,
* "other": [ ]
},
* "country_of_domicile": "string"
},
* "bill_of_lading_number": "string",
* "port_of_loading": "string",
* "port_of_discharge": "string",
* "vessel_name": "string",
* "vessel_imo_number": "IMO1234567",
* "commercial_line_items": [
* {
* "line_item_identification": null,
* "quantity": null,
* "unit_price": null,
* "product_name": null,
* "product_identifier": null
}
],
* "onboard_date": "string",
* "transferable": "TRAL",
* "container_number": "string",
* "subject_to_charter_party": true
}
}
]
}
]
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
FINANCE - REQUESTS THE ASSETS/TRANSACTIONS TO BE MARKED AS FINANCED BY THE
CALLER.
Requests the assets/transactions identified by the provided identifications to
be marked as financed by the caller at the validation service.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRFINANCE
Example: TFRFINANCE
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
submitting_financial_institution_identification
required
string <uuid> (UUIDv4Identifier) = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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.
financing_batch
required
Array of objects (BatchInformation5)
Use exactly ONE of the below _identification fields per financing_batch array
object. When using multiple financing_batch objects, ALL objects MUST contain
the same _identification type.
RESPONSES
201
Identifies commercial and trade data sets to finance.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
422
Unprocessable Entity
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/financings
Live environment
https://api.tfr.sg/trade-financing-validation/v1/financings
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/financings
REQUEST SAMPLES
* Payload
Content type
application/json
Example
financings_example1financings_example2financings_example3financings_example4financings_example1
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "financing_batch": [
* {
* "pool_identification": "AZN20200110"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 422
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
NEW SET - CREATES A NEW FINANCING VALIDATION REQUEST SET DEFINITION FOR
SUBSEQUENT STATUS RETRIEVAL FROM THE GET /STATUS ENDPOINT.
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:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRNEWSET
Example: TFRNEWSET
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
submitting_financial_institution_identification
required
string <uuid> (UUIDv4Identifier) = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122
"Universally Unique IDentifier (UUID) URN Namespace".
statuses_batch
required
Array of objects (BatchInformation8)
RESPONSES
201
Request the status of the registered data sets
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/status-requests
Live environment
https://api.tfr.sg/trade-financing-validation/v1/status-requests
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/status-requests
REQUEST SAMPLES
* Payload
Content type
application/json
Example
status_example1status_example2status_example3status_example4status_example1
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "statuses_batch": [
* {
* "pool_identification": "AZN20200110"
},
* {
* "pool_identification": "AZN20200111"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
GET STATUS - RETRIEVES FINANCING VALIDATION REQUEST REGISTRATION AND FINANCING
STATUS DETAILS.
Retrieves financing validation request registration and financing status details
at the validation service.
AUTHORIZATIONS:
ApiKeyAuth
PATH PARAMETERS
request-identification
required
string <uuid> = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
QUERY PARAMETERS
limit
integer
Example: limit=20
Maximum number of financing validation requests to return in the response
offset
integer
Example: offset=20
Offset of first element to start results from in dataset
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGETSTATUS
Example: TFRGETSTATUS
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
Registration and possibly matching status of the registered data sets in the
validation service.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/status/{request-identification}
Live environment
https://api.tfr.sg/trade-financing-validation/v1/status/{request-identification}
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/status/{request-identification}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/api/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
* "submitting_financial_institution_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "creation_date_time": "2019-08-24T14:15:22Z",
* "financing_validation_data_set_details": [
* {
* "tfr_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "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": "SGTRADEX_VALIDATION"
}
],
* "document_summary": {
* "document_type": "BOLD",
* "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",
* "shipper_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "consignee_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "carrier_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "bill_of_lading_number": "string",
* "port_of_loading": "string",
* "port_of_discharge": "string",
* "vessel_name": "string",
* "vessel_imo_number": "IMO1234567",
* "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
}
}
}
],
* "onboard_date": "string",
* "transferable": "TRAL",
* "container_number": "string",
* "subject_to_charter_party": true
},
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "trade_utility_matching": [
* {
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time":
"2022-10-10T16:29:20.000+00:00",
* "validation_status": "VALD",
* "matching_report": [
* {
* "element_name": "carrier_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name": "shipper_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name":
"shipper_identification.country_of_domicile",
* "matching_status": "MACH"
},
* {
* "element_name": "consignee_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name":
"consignee_identification.country_of_domicile",
* "matching_status": "MACH"
},
* {
* "element_name": "bill_of_lading_number",
* "matching_status": "MACH"
},
* {
* "element_name": "issue_date",
* "matching_status": "MACH"
},
* {
* "element_name": "vessel_name",
* "matching_status": "MACH"
},
* {
* "element_name": "vessel_imo_number",
* "matching_status": "MACH"
},
* {
* "element_name": "port_of_loading",
* "matching_status": "MACH"
},
* {
* "element_name": "port_of_discharge",
* "matching_status": "MACH"
}
]
}
],
* "trade_utility_data": [
* {
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time": "2019-08-24T14:15:22Z",
* "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",
* "is_financing_request_expired": true,
* "financing_request_duplicate_report": [
* {
* "dataset_match_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_tfr_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_data_set_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_submitter_dataset_identification": "string",
* "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": "2019-08-24T14:15:22Z",
* "proprietary_matching_details": {
* "proprietary_description": "UNIQUE"
},
* "related_document_match_identifications": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
],
* "sla_expiry_datetime": "2019-08-24T14:15:22Z",
* "tfr_status": "RED",
* "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"
}
]
}
]
}
GET STATUS METADATA - RETRIEVES FINANCING VALIDATION REQUEST REGISTRATION AND
FINANCING STATUS DETAILS.
Retrieves financing validation request registration and financing status details
at the validation service. This returns the financing and document metadata, and
results only. This endpoint is used by API users to provide a more concise
response.
AUTHORIZATIONS:
ApiKeyAuth
PATH PARAMETERS
request-identification
required
string <uuid> = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
QUERY PARAMETERS
limit
integer
Example: limit=20
Maximum number of financing validation requests to return in the response
offset
integer
Example: offset=20
Offset of first element to start results from in dataset
RESPONSES
200
Registration and possibly matching status of the registered data sets in the
validation service.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/status/{request-identification}/metadata
Live environment
https://api.tfr.sg/trade-financing-validation/v1/status/{request-identification}/metadata
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/status/{request-identification}/metadata
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/api/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
* "submitting_financial_institution_identification":
"ef04180b-43ef-4238-99ec-de718f9dc156",
* "creation_date_time": "2022-11-10T15:21:22Z",
* "financing_validation_data_set_details": [
* {
* "pool_identification": "pool123",
* "submitter_batch_identification": "batch1/2022-11-10",
* "batch_identification": "f94b4169-9004-4eb8-8693-d49d566282fb",
* "submitter_data_set_identification": "monetago-1-2022-11-10",
* "data_set_identification": "568be898-a0c3-44a0-8404-50618fdf2b7f",
* "referred_documents": [
* {
* "submitter_document_reference": "monetago-invoice-1",
* "registered_document_identification":
"452f147e-c99c-4401-a1fd-178c93f9e8ed",
* "document_duplicate_match_summaries": [
* {
* "match_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_date_time": "2022-11-10T15:21:24Z",
* "matching_report": [
* {
* "element_name": "invoice_number",
* "matching_status": "NMAT"
},
* {
* "element_name": "total_invoice_amount",
* "matching_status": "MACH"
},
* {
* "element_name": "seller_identification",
* "matching_status": "MACH"
},
* {
* "element_name": "buyer_identification",
* "matching_status": "MACH"
},
* {
* "element_name": "issue_date",
* "matching_status": "MACH"
}
],
* "proprietary_matching_details": {
* "proprietary_description": "HIGH_SIMILARITY"
}
}
]
}
],
* "financing_request_status": "DFIN",
* "is_financing_request_expired": false,
* "financing_request_duplicate_report": [
* {
* "match_identification": "8aef1aeb-3e9f-4ebe-a5f2-d208877d3637",
* "match_type": "PART",
* "matched_financing_request_status": "FNCD",
* "matched_financing_request_amount": {
* "currency": "SGD",
* "amount": "5000000.00"
},
* "financing_applicant_is_matched": true,
* "matched_date_time": "2022-11-10T15:21:24Z",
* "proprietary_matching_details": {
* "proprietary_description": "HIGH_RISK"
}
}
],
* "sla_expiry_datetime": "2022-11-12T15:21:22Z",
* "tfr_status": "RED"
}
]
}
GET FVRS - RETRIEVE A FILTERED LIST OF 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:
ApiKeyAuth
QUERY PARAMETERS
limit
integer
Example: limit=20
Maximum number of financing validation requests to return in the response
offset
integer
Example: offset=20
Offset of first element to start results from in dataset
after
string <date-time> (ISODateTime)
^(-?(?:[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 <date-time> (ISODateTime)
^(-?(?:[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)
tfr-identification
string
Example: tfr-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9
TFR identification of the individual Financing Validation Request
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
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGETFVRS
Example: TFRGETFVRS
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
List of Financing Validation Requests with statuses and validation results from
the validation service.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/financing-validation-requests
Live environment
https://api.tfr.sg/trade-financing-validation/v1/financing-validation-requests
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/financing-validation-requests
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/api/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "submitting_financial_institution_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "financing_validation_data_set_details": [
* {
* "tfr_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "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": "SGTRADEX_VALIDATION"
}
],
* "document_summary": {
* "document_type": "BOLD",
* "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",
* "shipper_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "consignee_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "carrier_identification": {
* "name": "string",
* "identifications": {
* "any_bic": "string",
* "lei": "stringstringstringst",
* "email_address": "string",
* "other": [
* {
* "identification": null,
* "scheme_name": null,
* "issuer": null
}
]
},
* "country_of_domicile": "string"
},
* "bill_of_lading_number": "string",
* "port_of_loading": "string",
* "port_of_discharge": "string",
* "vessel_name": "string",
* "vessel_imo_number": "IMO1234567",
* "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
}
}
}
],
* "onboard_date": "string",
* "transferable": "TRAL",
* "container_number": "string",
* "subject_to_charter_party": true
},
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "trade_utility_matching": [
* {
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time":
"2022-10-10T16:29:20.000+00:00",
* "validation_status": "VALD",
* "matching_report": [
* {
* "element_name": "carrier_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name": "shipper_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name":
"shipper_identification.country_of_domicile",
* "matching_status": "MACH"
},
* {
* "element_name": "consignee_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name":
"consignee_identification.country_of_domicile",
* "matching_status": "MACH"
},
* {
* "element_name": "bill_of_lading_number",
* "matching_status": "MACH"
},
* {
* "element_name": "issue_date",
* "matching_status": "MACH"
},
* {
* "element_name": "vessel_name",
* "matching_status": "MACH"
},
* {
* "element_name": "vessel_imo_number",
* "matching_status": "MACH"
},
* {
* "element_name": "port_of_loading",
* "matching_status": "MACH"
},
* {
* "element_name": "port_of_discharge",
* "matching_status": "MACH"
}
]
}
],
* "trade_utility_data": [
* {
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time": "2019-08-24T14:15:22Z",
* "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",
* "is_financing_request_expired": true,
* "financing_request_duplicate_report": [
* {
* "dataset_match_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_tfr_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_data_set_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_submitter_dataset_identification": "string",
* "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": "2019-08-24T14:15:22Z",
* "proprietary_matching_details": {
* "proprietary_description": "UNIQUE"
},
* "related_document_match_identifications": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
],
* "sla_expiry_datetime": "2019-08-24T14:15:22Z",
* "tfr_status": "RED",
* "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"
}
]
}
]
}
GET FVRS METADATA - RETRIEVE A FILTERED LIST OF FINANCING VALIDATION REQUESTS.
Alternative method to retrieve a filtered list of financing validation requests
belonging to the calling entity as a financier. This version contains financing
and document metadata only (identifiers) and results without the full details.
This is used as a more concise response for API users.
AUTHORIZATIONS:
ApiKeyAuth
QUERY PARAMETERS
limit
integer
Example: limit=20
Maximum number of financing validation requests to return in the response
offset
integer
Example: offset=20
Offset of first element to start results from in dataset
after
string <date-time> (ISODateTime)
^(-?(?:[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 <date-time> (ISODateTime)
^(-?(?:[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
RESPONSES
200
List of Financing Validation Requests with statuses and validation results from
the validation service.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/financing-validation-requests/metadata
Live environment
https://api.tfr.sg/trade-financing-validation/v1/financing-validation-requests/metadata
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/financing-validation-requests/metadata
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/api/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=80",
* "rel": "last",
* "type": "GET"
}
],
* "submitting_financial_institution_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "financing_validation_data_set_details": [
* {
* "tfr_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "pool_identification": "string",
* "submitter_batch_identification": "string",
* "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "submitter_data_set_identification": "string",
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "referred_documents": [
* {
* "submitter_document_reference": "string",
* "trade_utility_service": [
* {
* "service_name": "SGTRADEX_VALIDATION"
}
],
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "trade_utility_matching": [
* {
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time":
"2022-10-10T16:29:20.000+00:00",
* "validation_status": "VALD",
* "matching_report": [
* {
* "element_name": "carrier_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name": "shipper_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name":
"shipper_identification.country_of_domicile",
* "matching_status": "MACH"
},
* {
* "element_name": "consignee_identification.name",
* "matching_status": "MACH"
},
* {
* "element_name":
"consignee_identification.country_of_domicile",
* "matching_status": "MACH"
},
* {
* "element_name": "bill_of_lading_number",
* "matching_status": "MACH"
},
* {
* "element_name": "issue_date",
* "matching_status": "MACH"
},
* {
* "element_name": "vessel_name",
* "matching_status": "MACH"
},
* {
* "element_name": "vessel_imo_number",
* "matching_status": "MACH"
},
* {
* "element_name": "port_of_loading",
* "matching_status": "MACH"
},
* {
* "element_name": "port_of_discharge",
* "matching_status": "MACH"
}
]
}
],
* "trade_utility_data": [
* {
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time": "2019-08-24T14:15:22Z",
* "trade_utility_data_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
],
* "document_duplicate_match_summaries": [
* {
* "document_match_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "dataset_match_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_submitter_document_reference": "string",
* "matched_date_time": "2019-08-24T14:15:22Z",
* "matching_report": [
* {
* "element_name": "InvoiceNumber",
* "matching_status": "MACH"
}
],
* "proprietary_matching_details": {
* "proprietary_description": "UNIQUE"
}
}
]
}
],
* "financing_request_status": "DFIN",
* "is_financing_request_expired": true,
* "financing_request_duplicate_report": [
* {
* "dataset_match_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_tfr_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_data_set_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "matched_submitter_dataset_identification": "string",
* "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": "2019-08-24T14:15:22Z",
* "proprietary_matching_details": {
* "proprietary_description": "UNIQUE"
}
}
],
* "sla_expiry_datetime": "2019-08-24T14:15:22Z",
* "tfr_status": "RED",
* "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 - REQUESTS CANCELLATION OF REGISTRATION AND FINANCING OF
ASSETS/TRANSACTIONS.
Requests cancellation of registration and financing of assets/transactions
identified by the provided identifications.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRCANCEL
Example: TFRCANCEL
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
submitting_financial_institution_identification
required
string <uuid> (UUIDv4Identifier) = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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.
cancellation_batch
required
Array of objects (BatchInformation6)
RESPONSES
201
Requests cancellation of registered commercial and trade data sets.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/cancellations
Live environment
https://api.tfr.sg/trade-financing-validation/v1/cancellations
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/cancellations
REQUEST SAMPLES
* Payload
Content type
application/json
Example
cancellation_example1cancellation_example2cancellation_example1
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "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
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000"
}
GET MATCHES - RETRIEVES A FILTERED LIST OF DOCUMENT MATCH DETAILS INVOLVING THE
CALLING ENTITY AS FINANCIER, CONFORMING THE QUERY PARAMETERS.
Retrieves a filtered list of document match details involving the calling entity
as financier, conforming the query parameters.
AUTHORIZATIONS:
ApiKeyAuth
QUERY PARAMETERS
after
string <date-time> (ISODateTime)
^(-?(?:[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 <date-time> (ISODateTime)
^(-?(?:[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 identified. Default is current time
limit
integer
Example: limit=1000
Maximum number of matches to return in the response (use only in conjunction
with after/before)
offset
integer
Example: offset=3000
Offset of first element to start results from in dataset (use only in
conjunction with after/before)
match-type
string
Enum: "EXCT" "PART"
Exact or Partial matches only
request_identification
string
Example: request_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9
Associated request identification UUID provided as part of registration response
data_set_identification
string
Example: data_set_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9
System generated UUID identification of the FVR
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGETMATCHES
Example: TFRGETMATCHES
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
List of document matches involving the calling entity as financier
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/document-matches
Live environment
https://api.tfr.sg/trade-financing-validation/v1/document-matches
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/document-matches
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/api/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/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": "2019-08-24T14:15:22Z",
* "matching_report": [
* {
* "element_name": "InvoiceNumber",
* "matching_status": "MACH"
}
],
* "proprietary_matching_details": {
* "proprietary_description": "UNIQUE"
},
* "registered_document_identification_list": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
]
}
GET MATCH - RETRIEVES INDIVIDUAL DOCUMENT MATCH DETAILS INVOLVING THE CALLING
ENTITY AS FINANCIER.
Retrieves individual document match details involving the calling entity as
financier.
AUTHORIZATIONS:
ApiKeyAuth
PATH PARAMETERS
match-identification
required
string
identification of the pairwise match
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGETMATCH
Example: TFRGETMATCH
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
Duplicate Document Matching Information
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/document-matches/{match-identification}
Live environment
https://api.tfr.sg/trade-financing-validation/v1/document-matches/{match-identification}
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/document-matches/{match-identification}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 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": "2019-08-24T14:15:22Z",
* "matching_report": [
* {
* "element_name": "InvoiceNumber",
* "matching_status": "MACH"
}
],
* "proprietary_matching_details": {
* "proprietary_description": "UNIQUE"
},
* "registered_document_identification_list": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
GET CANCELLATION - RETRIEVES CANCELLATION STATUS OF RECEIVABLES.
Retrieves cancellation status of receivables at the validation service.
AUTHORIZATIONS:
ApiKeyAuth
PATH PARAMETERS
cancellation-identification
required
string <uuid> = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGETCNCLLTN
Example: TFRGETCNCLLTN
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
Data Set Cancellation Status
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/cancellations/{cancellation-identification}/status
Live environment
https://api.tfr.sg/trade-financing-validation/v1/cancellations/{cancellation-identification}/status
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/cancellations/{cancellation-identification}/status
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000",
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "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"
}
]
}
EXTEND SLA - REQUESTS FOR THE SLA FINANCING DECISION PERIOD TO BE EXTENDED BY
ANOTHER 24H
Requests for the SLA financing decision period to be extended by another 24h if
no decision has been reached within the initial SLA period. Expiry of the SLA
will result in the ability for other financiers to finance the transaction.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFREXTENDSLA
Example: TFREXTENDSLA
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
extension_batch
required
Array of objects (BatchInformation8)
RESPONSES
201
Identifies commercial and trade data sets to finance.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/extensions
Live environment
https://api.tfr.sg/trade-financing-validation/v1/extensions
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/extensions
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "extension_batch": [
* {
* "tfr_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "request_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "pool_identification": "string",
* "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "submitter_data_set_identification": "string"
}
]
}
RESPONSE SAMPLES
* 201
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}
HEALTHCHECK
Internal Service Health Check endpoints
ENDPOINT FOR SERVICE HEALTH CHECK.
Endpoint for service health check.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRHEALTHCHECK
Example: TFRHEALTHCHECK
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
Service OK
400
Bad Request
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/health-check
Live environment
https://api.tfr.sg/trade-financing-validation/v1/health-check
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/health-check
RESPONSE SAMPLES
* 200
* 400
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
"OK"
NOTIFICATIONS
Notification endpoints to poll for new results activity
GET ACTIVITY - RETRIEVES LIST OF LATEST RESULT ACTIVITY TO PROVIDE SINGLE
POLLING ENDPOINT.
Endpoint to provide list of activity relating to new results to avoid polling
individual datasets independently. Usage patterns - 1. before, after, limit,
offset 2. Exactly one of _identification fields. Only 1. or 2. can be utilized
per GET /activity call.
AUTHORIZATIONS:
ApiKeyAuth
QUERY PARAMETERS
after
string <date-time> (ISODateTime)
^(-?(?:[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 <date-time> (ISODateTime)
^(-?(?:[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
limit
integer
Example: limit=1000
Maximum number of events to return in the response (use only in conjunction with
after/before)
offset
integer
Example: offset=3000
Offset of first element to start results from in dataset (use only in
conjunction with after/before)
tfr_identification
string
Example: tfr_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9
tfr identification
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
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGETACTIVITY
Example: TFRGETACTIVITY
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
List of latest activity relating to datasets.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/activity
Live environment
https://api.tfr.sg/trade-financing-validation/v1/activity
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/activity
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Example
activity_green_lightactivity_cancel_successactivity_cancel_rejectedactivity_amber_to_red_as_bank_a_processes_financingactivity_register_high_risk_duplicate_after_bank_aactivity_green_light
Copy
Expand all Collapse all
{
* "links": [
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=40",
* "rel": "self",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=0",
* "rel": "first",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/v1/activity?limit=20,offset=60",
* "rel": "next",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/api/v1/activity?limit=20,offset=20",
* "rel": "previous",
* "type": "GET"
},
* {
* "href":
"https://api.tfr.sg/trade-financing-validation/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",
* "tfr_identification": "693fc2ec-7448-4e1d-b48b-210198d96375",
* "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": "TFR_STATUS",
* "status": "GREEN"
},
* {
* "service_name": "FINANCING_REQUEST_STATUS",
* "status": "REGU"
}
]
}
]
}
ACTIVITY CALLBACK - RECEIVE LIST OF LATEST RESULT ACTIVITY
Endpoint to be implemented by the bank providing list of activity relating to
new results. This will not be implemented on the TFR side. URL will be replaced
with the bank's /route url. Callbacks will be sent at 30 second intervals if
non-zero events have been generated in that duration. Note - Polling period
subject to validation during performance testing.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRACTIVITYCALL
Example: TFRACTIVITYCALL
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
events
Array of objects (ResultEvent)
List containing the latest result activity events such as duplicate
identifications and authentication result updates
RESPONSES
202
Acknowledgement of successful receipt.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/activity
Live environment
https://api.tfr.sg/trade-financing-validation/v1/activity
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/activity
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "events": [
* {
* "event_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "event_date_time": "2019-08-24T14:15:22Z",
* "tfr_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "pool_identification": "string",
* "submitter_batch_identification": "string",
* "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "submitter_data_set_identification": "string",
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "request_identifications": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
],
* "event_details": [
* {
* "service_name": "TFR_STATUS",
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "status": "DFIN"
}
]
}
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "severity": "Fatal",
* "code": "string",
* "text": "string",
* "user_message": "string",
* "more_info": "http://example.com"
}
DOCUMENTAUTHENTICATION
Endpoints for managing Document Authentication processes (Genuineness
Validation) against Trade Utility Services
CREATE TRADE UTILITY ACCOUNT - SETS UP TRADE UTILITY ACCOUNT OWNER DATA FOR
TRADE UTILITIES TO GET CONSENT AND CREDENTIALS FROM OWNER. DEPRECATED
Sets up trade utility account owner data (without financings input) at the
validation service, linked to a financier.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRCTUACCNT
Example: TFRCTUACCNT
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
submitting_financial_institution_identification
required
string <uuid> (UUIDv4Identifier) = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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 (PartyIdentification)
Specifies the identification of an organisation.
trade_utility_account_holder_contacts
Array of objects (ContactIdentification6)
trade_utility_credential_requests
Array of objects (TradeUtilityCredentialDetails1)
RESPONSES
201
Resource with trade utility account owner details
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/trade-utility-accounts
Live environment
https://api.tfr.sg/trade-financing-validation/v1/trade-utility-accounts
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/trade-utility-accounts
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "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
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}
EDIT TRADE UTILITY ACCOUNT - EDITS TRADE UTILITY ACCOUNT OWNER DATA FOR TRADE
UTILITIES TO GET CONSENT AND CREDENTIALS FROM OWNER. DEPRECATED
Edits trade utility account owner data (without financings input) at the
validation service, linked to a financier.
AUTHORIZATIONS:
ApiKeyAuth
PATH PARAMETERS
account-identification
required
string <uuid> = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRETUACCNT
Example: TFRETUACCNT
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
submitting_financial_institution_identification
required
string <uuid> (UUIDv4Identifier) = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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 (PartyIdentification)
Specifies the identification of an organisation.
trade_utility_account_holder_contacts
Array of objects (ContactIdentification6)
trade_utility_credential_requests
Array of objects (TradeUtilityCredentialDetails1)
RESPONSES
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
patch/trade-utility-accounts/{account-identification}
Live environment
https://api.tfr.sg/trade-financing-validation/v1/trade-utility-accounts/{account-identification}
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/trade-utility-accounts/{account-identification}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "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": "SGTRADEX"
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}
GET TRADE UTILITY ACCOUNT - RETRIEVES TRADE UTILITY ACCOUNT OWNER SETUP DATA.
DEPRECATED
Retrieves trade utility account owner setup data at the validation service.
AUTHORIZATIONS:
ApiKeyAuth
PATH PARAMETERS
account-identification
required
string <uuid> = 36 characters
[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a...Show pattern
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
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGTUACCNT
Example: TFRGTUACCNT
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
Information about the registered trade utility account owner
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/trade-utility-accounts/{account-identification}/status
Live environment
https://api.tfr.sg/trade-financing-validation/v1/trade-utility-accounts/{account-identification}/status
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/trade-utility-accounts/{account-identification}/status
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "submitting_financial_institution_identification":
"16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
* "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 TRADE UTILITY DATA - RETRIEVES RAW TRADE UTILITY DATA FOR A SPECIFIC
DOCUMENT AUTHENTICATION REQUEST.
Retrieves full raw trade utility data for a specific document authentication
request which completed.
AUTHORIZATIONS:
ApiKeyAuth
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
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRGTUDATA
Example: TFRGTUDATA
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
RESPONSES
200
Raw Trade Utility Service data
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
get/trade-utility-data/{trade-utility-data-identification}
Live environment
https://api.tfr.sg/trade-financing-validation/v1/trade-utility-data/{trade-utility-data-identification}
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/trade-utility-data/{trade-utility-data-identification}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "trade_utility_data_identification": "aa69fd4c-7674-484f-aa57-70ae72ea02b7",
* "business_service": "SGTRADEX_VALIDATION",
* "current_status_date_time": "2022-10-13T12:03:00.000Z",
* "data":
"{\"blv_carrier_name\":\"string\",\"blv_bl_number\":\"string\",\"blv_issuance_date\":\"2022-10-12T16:44:55.831Z\",\"blv_vessel_name\":\"string\",\"blv_vessel_imo_number\":\"string\",\"blv_port_of_loading\":\"string\",\"blv_port_of_discharge\":\"string\",\"blv_quantity_value\":\"string\",\"blv_quantity_unit_of_measure_code\":\"string\",\"blv_quantity_other_unit_of_measure\":\"string\",\"blv_goods_description\":\"string\",\"blv_shipper_name\":\"string\",\"blv_consignee_name\":\"string\",\"blv_shipper_country\":\"string\",\"blv_consignee_country\":\"string\",\"verified\":\"NOT
APPLICABLE\"}"
}
CALLBACKS
Callback endpoints via CCP to be implemented as a web service by banks
ACTIVITY CALLBACK - RECEIVE LIST OF LATEST RESULT ACTIVITY
Endpoint to be implemented by the bank providing list of activity relating to
new results. This will not be implemented on the TFR side. URL will be replaced
with the bank's /route url. Callbacks will be sent at 30 second intervals if
non-zero events have been generated in that duration. Note - Polling period
subject to validation during performance testing.
AUTHORIZATIONS:
ApiKeyAuth
HEADER PARAMETERS
Date
required
string
Example: Tue, 05 May 2022 08:12:31 GMT
Common parameter that defines the request date and time. The format using the
“HTTP-date” format which is defined in RFC7231
Host
required
string
Example: bcs.vcp.sg.com
The domain name and/or port number of the server.
X-Ccp-Api-Uid
required
string <= 36 characters
Example: A20220822AABKSGSGP000000001
Unique API ID per API call. Proposed Format: AYYYYMMDDAAAAAAAASNNNNNNNNN A -
Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA – Business Identifier Code S –
Source (P for Participant, F for Platform, C for CCP) NNNNNNNNN – Numeric Unique
Identifier
X-Ccp-Api-Tid
required
string <= 36 characters
Example: C20220822AABKSGSGP000000001
API Transaction reference number (Correlation ID) Proposed Format:
CYYYYMMDDAAAAAAAASNNNNNNNNN C - Fixed value YYYYMMDD –Year, Month, Date AAAAAAAA
– Business Identifier Code S – Source (P for Participant, F for Platform)
NNNNNNNNN – Numeric Unique Identifier
Authorization
string
Example: Bearer ABC123.DEF456.GHI789
Required if OAuth 2.0 is used.
Accept
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
Content-Type
string
Default: application/json
Example: application/json
Common parameter that defines the media type of the request body.
X-Ccp-Api-Eid
required
string
Default: TFRACTIVITYCALL
Example: TFRACTIVITYCALL
API endpoint ID mapped to the actual platform API endpoint
X-Ccp-Mode
required
string <= 3 characters
Example: SEC
Flag to indicate Secure or Forward mode (SEC / FWD)
X-Ccp-From-Id
required
string <= 11 characters
Example: AABKSGSGXXX
The business identifier code of the originating participant/platform
X-Ccp-To-Id
required
string <= 11 characters
Example: SYSTSGSGXXX
The business identifier code of the destination participant/platform.
X-Ccp-Issuer-Key
string <= 10 characters
Example: KEYALIAS1
Alias of the encryption key of sender. Required if the API mode is Secure.
X-Ccp-Recv-Key
string <= 10 characters
Example: KEYALIAS2
Alias of the encryption key of receiver. Required if the API mode is Secure.
REQUEST BODY SCHEMA: APPLICATION/JSON
events
Array of objects (ResultEvent)
List containing the latest result activity events such as duplicate
identifications and authentication result updates
RESPONSES
202
Acknowledgement of successful receipt.
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout
default
Internal Server Error
post/activity
Live environment
https://api.tfr.sg/trade-financing-validation/v1/activity
Customer Test environment
https://api.uat.tfr.sg/trade-financing-validation/v1/activity
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "events": [
* {
* "event_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "event_date_time": "2019-08-24T14:15:22Z",
* "tfr_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "pool_identification": "string",
* "submitter_batch_identification": "string",
* "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "submitter_data_set_identification": "string",
* "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "request_identifications": [
* "d827f76c-c42f-45ae-8972-0597dce2c6e6"
],
* "event_details": [
* {
* "service_name": "TFR_STATUS",
* "registered_document_identification":
"d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
* "status": "DFIN"
}
]
}
]
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
* 406
* 429
* 500
* 503
* 504
* default
Content type
application/json
Copy
{
* "severity": "Fatal",
* "code": "string",
* "text": "string",
* "user_message": "string",
* "more_info": "http://example.com"
}