Submit a Bill of Lading for screening

Production

https://api.polestar-production.com

POST

/purpletrac/v1/blv

Registers the bill of lading by providing the SCAC code and BL number in the body and triggers the screening workflow.

Refer to Bill of Lading Verification to see how to use this endpoint in a bill of lading screening workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The bill of lading was accepted for screening. Carries the blv_id the other Bill of Lading endpoints take.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

DefaultIncluding Client Reference

curl --location 'https://api.polestar-production.com/purpletrac/v1/blv?username=undefined&api_key=%3Capi-key%3E' \
--header 'Content-Type: application/json' \
--data '{
    "scac": "CMDU",
    "blv_no": "ISB1235295",
    "client_reference": ""
}'

Response Example

200 - Screening accepted

{
    "archived": false,
    "blv_no": "ISB1235295",
    "blv_phase_status": "SCREEN",
    "client_reference": "",
    "creation_date": "2023-12-11 14:40:27.171665+00:00",
    "id": 35260,
    "is_trackable": true,
    "last_screening_result": {
        "carrier_severity": "PENDING",
        "details": {},
        "id": 38353,
        "overall_severity": "PENDING",
        "port_of_destination": null,
        "port_of_origin": null,
        "screened_ports": [],
        "screened_ships": [],
        "screening_date": "2023-12-11T14:40:27.178234",
        "screening_status": "SCREENING"
    },
    "notifications": [],
    "num_notifications": 0,
    "overall_severity": "PENDING",
    "resource_uri": "/api/v1/blv/35260",
    "scac": "CMDU",
    "scac_name": "CMA CGM",
    "screening_status": "SCREENING",
    "ship_transactions": []
}

Modified at 2026-09-30 14:02:12

Verification

Get all BL Screening Results