Skip to main contentFreight Trust

Finance

Financial Institutions

This REST API is exclusively for use by financial institution organizations to provide access to platform data.

Endpoints

TradeInstrumentVerifier

getBolDocumentUsingPOST

POST /api/v1/TradeInstrumentVerifier/search

Fetch Bill Of Lading document.

Description

Fetch a Trade Instrument, such as a Bill Of Lading, matching all the input parameters. The API will allow the caller to download the First Matching Bill Of Lading document matching all the input parameters. This API is accessible only to org’s of type Financial Institution and those that has been entitled to access the API tradeInstrumentVerifier: An exact case insensitive match is done for this parameter. oceanCarrierCode: An exact case insensitive match is done for this parameter. consignorPrintedParty: A partial case insensitive match is done for this parameter. Minimum acceptable length is 6 characters.

Parameters
Body Parameter
NameDescriptionRequiredDefaultPattern
TDocVerifyRequestRequest object for BoL Verifier TDocVerifyRequestX
Return Type

- Content-Type: application/json Content-Length: maxLength, 32 -

Content Type
  • /
Responses
CodeMessageDatatype
200OK\<\<>>
400Bad request AppExceptionResponse
401Unauthorized\<\<>>
403Forbidden\<\<>>
404No matching Bill of Lading available on the platform for the provided set of input params AppExceptionResponse
500Server Error AppExceptionResponse

http response codes

Samples

Models

AppExceptionResponse AppExceptionResponse

Field NameRequiredTypeDescriptionFormat
codeXStringError Code
messageXStringException Message
timestampXStringtimestamp

TDocVerifyRequest TDocVerifyRequest

Field NameRequiredTypeDescriptionFormat
tradeInstrumentVerifierXStringBill Of Lading number to search for
oceanCarrierCodeXStringCarrier SCAC code
consignorPrintedPartyXStringConsignor details field as in the Bill Of Lading document
General Contact
Request Information
E-Mail
corporate@freighttrust.com
Partners
Become a Partner