Vetting API

Authorization

Bearer <access-token>

Yes

Bearer token obtained via Auth0 authentication.

Content-Type

application/json

Yes

data

array

Yes

page_size

integer

No

next_cursor

string nullable

Yes

200

Successful

400

Bad Request – missing or invalid input parameters.

401

Unauthenticated – the access token is missing or expired.

403

Unauthorized – the user is authenticated but lacks permission to access the resource.

500

Unexpected error – contact support with any returned error messages.

GET

/api/vet/

vet_platform_id

integer nullable

No

Filter results to a single vet record by its platform ID.

page_size

integer nullable

No

Number of records to return per page. Defaults to a system-defined limit if omitted.

cursor

string nullable

No

Pagination cursor from a previous response. Pass this to retrieve the next page.

IDENTIFIERS

vet_platform_id

integer

Unique identifier for the vet record on the RightShip platform.

external_transaction_reference

string nullable

External reference ID supplied by the requesting organisation at vet creation.

VESSEL PARTICULARS

vessel_name

string nullable

Name of the vessel at the time of the vet request.

imo

string nullable

IMO number of the vessel.

dwt

number nullable

Deadweight tonnage of the vessel.

vessel_type

string nullable

Vessel type classification (e.g. Bulk Carrier, Tanker).

cargo_type

string nullable

Cargo type associated with the vet request.

year_of_build

integer nullable

Year the vessel was built.

vin

string nullable

Vessel Identification Number.

eni

string nullable

European Number of Identification (inland waterways vessels).

RATINGS AT VET DECISION

safety_score_at_vet_decision

integer nullable

RightShip Safety Score recorded at the time the vet decision was made.

ghg_rating_at_vet_decision

string nullable

GHG rating (e.g. A–G) recorded at the time of the vet decision.

evdi_at_vet_decision

number nullable

Energy Vessel Design Index value recorded at the time of the vet decision.

cii_rating_at_vet_decision

string nullable

CII rating (e.g. A–E) recorded at the time of the vet decision.

PEOPLE

ship_manager_emails

string[] nullable

Email addresses of the ship manager contacts associated with the vessel.

requester_full_name

string nullable

Full name of the user who submitted the vet request.

requester_business_unit

string nullable

Business unit of the requester within their organisation.

requester_company

string nullable

Company name of the requester.

customer_decision_reviewer_full_name

string nullable

Full name of the person who reviewed and set the customer decision.

last_modified_by_full_name

string nullable

Full name of the user who last modified the vet record.

PORT & TRADE

load_port_name

string nullable

Name of the load port.

load_country

string nullable

Country of the load port.

discharge_port_name

string nullable

Name of the discharge port.

discharge_country

string nullable

Country of the discharge port.

inco_term

string nullable

Incoterm associated with the vet request (e.g. CIF, FOB).

DECISION & STATUS

vet_state_internal

string nullable

Internal RightShip state of the vet (e.g. Approved, Rejected, Pending).

customer_decision

string nullable

The customer's own decision recorded against the vet outcome.

TIMESTAMPS

vet_request_utc_date

string nullable

UTC datetime when the vet was originally requested (ISO 8601).

decision_utc_date

string nullable

UTC datetime when RightShip issued its vet decision (ISO 8601).

customer_decision_utc_date

string nullable

UTC datetime when the customer recorded their decision (ISO 8601).

latest_state_utc_date

string nullable

UTC datetime of the most recent state change on the vet record (ISO 8601).

record_system_time

string nullable

System timestamp of when the record was last written to the data store (ISO 8601).