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... Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".
required	Array of objects (BatchInformation3)

Responses

Request samples

Payload

Content type

application/json

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

Content type

application/json

{"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... Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".
batch_booking	boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element.
batch_booking_override	boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element.
required	Array of objects (BatchInformation5) 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

Request samples

Payload

Content type

application/json

Example

financings_example1

{"submitting_financial_institution_identification": "16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
"financing_batch": [{"pool_identification": "AZN20200110"
}
]
}

Response samples

Content type

application/json

{"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... Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".
required	Array of objects (BatchInformation8)

Responses

Request samples

Payload

Content type

application/json

Example

status_example1

{"submitting_financial_institution_identification": "16c6d3a2-be98-45e9-a01c-7b6c6001fcf3",
"statuses_batch": [{"pool_identification": "AZN20200110"
},
{"pool_identification": "AZN20200111"
}
]
}

Response samples

Content type

application/json

{"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...

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

Response samples

Content type

application/json

{"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...

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

Response samples

Content type

application/json

{"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])... 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])... 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

Response samples

Content type

application/json

{"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])... 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])... 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

Response samples

Content type

application/json

{"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... Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".
batch_booking	boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element.
batch_booking_override	boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element.
required	Array of objects (BatchInformation6)

Responses

Request samples

Payload

Content type

application/json

Example

cancellation_example1

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

Content type

application/json

{"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])... 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])... 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

Response samples

Content type

application/json

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

Response samples

Content type

application/json

{"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...

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

Response samples

Content type

application/json

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

required

Array of objects (BatchInformation8)

Responses

Request samples

Payload

Content type

application/json

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

Content type

application/json

{"request_identification": "123e4567-e89b-42d3-a456-426614174000"
}

HealthCheck

Internal Service Health Check endpoints

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

Response samples

Content type

application/json

"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])... 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])... 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

Response samples

Content type

application/json

Example

activity_green_light

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

Array of objects (ResultEvent)

List containing the latest result activity events such as duplicate identifications and authentication result updates

Responses

Request samples

Payload

Content type

application/json

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

Content type

application/json

{"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... Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".
required	object (PartyIdentification) Specifies the identification of an organisation.
	Array of objects (ContactIdentification6)
	Array of objects (TradeUtilityCredentialDetails1)

Responses

Request samples

Payload

Content type

application/json

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

Content type

application/json

{"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...

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... Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".
required	object (PartyIdentification) Specifies the identification of an organisation.
	Array of objects (ContactIdentification6)
	Array of objects (TradeUtilityCredentialDetails1)

Responses

Request samples

Payload

Content type

application/json

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

Content type

application/json

{"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...

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

Response samples

Content type

application/json

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

Response samples

Content type

application/json

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

Array of objects (ResultEvent)

List containing the latest result activity events such as duplicate identifications and authentication result updates

Responses

Request samples

Payload

Content type

application/json

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

Content type

application/json

{"severity": "Fatal",
"code": "string",
"text": "string",
"user_message": "string",
"more_info": "http://example.com"
}