All Collections
API
Vet submission API
Vet submission API
Updated over a week ago

All APIs require authentication, which is delegated to Auth0. Before any of the following external APIs can be accessed, the requestor needs to authenticate using a client id and client secret. The returned bearer token is then added to the request headers

VET API

The Vet API allows access to vet submission and vet submit status retrieval.

Usage

To use the Vet API, an account is required to obtain an Access Token by

authenticating. All requests must be formatted as JSON and contain the following

headers:

Header Name

Header Value

Optional

Comments

Authorization

Bearer <access-
token>

false

Content-Type

application/json

false

X-Version

1

true

If omitted,
latest version
will be used

Each response will have the following structure, where data field will contain the
actual data payload.

Property Name

Property Type

Can be Empty

Success

bool

false

ErrorMessage

String?

true

Data

Payload Data Type

true

Example response including data

{
"success": true,
"errorMessage": null,
"data": {
"uniqueCode": "RS_00000003"
}
}


Response Codes

Http Response Code

Description

200

Successful

400

Bad Request – Missing/invalid input parameters

401

Unauthenticated – the authentication access token is missing or expired.

403

Unauthorized – the user is logged in successfully, however does not have permission to access the requested resource.

500

Unexpected error – please contact support along with any returned error messages.

Submit VET

Create a new vet. Vet will be created for the user associated to the client access token.
Request Uri: [HttpPost] /api/Vet
Request:

Property Name

Property Type

Optional

Comments

VesselIMO

string

false

Vessel International Maritime Organization Number

TransactionId

string?

true

Existing transaction identifier

RequestedOnBehalfOfCompanyName

string?

true

Create Vet on behalf of another company

RequestedOnBehalfOfName

string?

true

Create Vet on behalf of another company

RequestedOnBehalfOfEmail

string?

true

Create Vet on behalf of another company

LoadPortExternalCode

string

false

Load port

EstimatedDateOfLoad

Date?

true

Estimated date of load

DischargePort

string

false

Discharge port

EstimatedDateOfDischarge

Date?

true

Estimated date of discharge

CargoTypeExternalCode

string

false

Cargo type

IncoTermsExternalCode

string

false

Inco term

Berth

string?

true

Berth

VetForShipToShip

bool?

true

Ship to ship vet

VetForTimeCharter

bool?

true

Time charter vet

Comments

string?

true

Comments

IsConfirmed

bool?

true

Is vet confirmed

Response:

Property Name

Property Type

Can Be Empty

Comments

UniqueIdentifier

String?

True

If the vet creation request was successful, this will contain a unique identifier for the new vet submission.

Notes:
- Any codes required are provided by their respective APIs, for instance
IncoTermsExternalCode can be retrieved from the IncoTerms API documented
below.
- Any fields in the request body which are marked with a ‘?’ are optional.
- When the vet request is submitted, the creation part of the vet submission is
queued. The uniqueIdentifier in the response can be used to query the vet
creation status by calling the get VetStatus API.


​Vet Status API

Get VET Status

Get the creation status of a previously created Vet.

Request Uri: [HttpGet] /api/VetStatus/{VetUniqueCode}
Request: empty
Response:

Property Name

Property Type

Can Be Empty

Comments

UniqueIdentifier

string

false

RequestTimestamp

DateTime

false

Status

string

false

LastStatusUpdateTimestamp

DateTime

false

StatusSnippet

string

false

VettingComments

string

false

SafetyScore

decimal?

true

GhgRating

string?

true

GhgRatingVerification

string?

true

InspectionStatus

int?

true

InspectionExpiryDate

DateTime?

true

RequestedOnBehalfOfCompanyName

string?

true

RequestedOnBehalfOfName

string?

true

RequestedOnBehalfOfEmail

string?

true

Rules

Rule[]

false

Related Activities

RelatedActivity[]

true

Rules:

Property Name

Property Type

Can Be Empty

Comments

Timestamp

DateTime

false

Outcome

string

false

IsSuccessful

string

false

IsInformationRule

Bool

false

Name

string

false

Related Activities:

Property Name

Property Type

Can Be Empty

Comments

Status

string

true

Title

string

true

Did this answer your question?