External API v1

Voyage Risk API

Add explainable maritime route-risk scoring to your supply-chain platform. Score one voyage or a portfolio, retain results for audit, and monitor corridors for material change.

Run a real assessment Read API documentation
Operational Test environment OpenAPI 3.1 Manual evaluation approval

Public playground

Run a real API assessment

This preview uses the production route and scoring engine and returns the external-v1 response shape. It is not retained and does not consume client quota.

Try
POST /api/v1/voyage-assessmentsCanonical request
{
  "route": {
    "origin": { "locode": "SGSIN" },
    "destination": { "locode": "NLRTM" },
    "vessel_type": "container"
  }
}
0Pending
RouteJWCPiracy

Ranked risk drivers


          

        

      

    


    

      

        
Integration surface

        
One contract from assessment to monitoring

        
Use the synchronous endpoint in an interactive workflow, queue portfolio assessments in batches, then promote material corridors into retained monitoring.

        

          
POST /voyage-assessments
Synchronous scoring
Return route geometry, score, confidence, ranked drivers, missing sources, and source status in one response.

          
POST /voyage-assessment-batches
Portfolio assessment
Queue multiple routes, poll batch status, and retrieve item-level results or structured errors.

          
POST /corridor-monitors
Corridor monitoring
Retain important routes and evaluate them on the entitlement cadence for material risk changes.

          
POST /webhook-endpoints
Signed delivery
Receive HMAC-SHA256 signed change, recovery, degradation, batch, and quota events.

          
Idempotency-Key
Replay-safe mutations
Safely retry transport and transient failures without duplicating accepted work.

          
GET /usage
Visible limits
Read environment-specific quota, batch size, monitoring cadence, and retention directly from the API.

        

      

    


    

      

        
Supply-chain workflow

        
Designed to enter an existing platform

        
The API returns derived decision-support intelligence rather than redistributing raw third-party feeds.

        

          
01
Normalize the lane
Submit UN/LOCODE endpoints and optional vessel operating context.

          
02
Score the route
Evaluate the actual sea path against current maritime intelligence signals.

          
03
Explain the result
Present ranked drivers, confidence, and source health beside the composite score.

          
04
Retain or monitor
Keep the assessment for audit or subscribe the corridor to material-change events.

        

      

    


    

      

        
Contract

        
Predictable integration behavior

        
Every response carries a request ID. Errors use one structured envelope and accepted work exposes quota headers.

        

          

            
ConcernBehaviorClient action

            
              
AuthenticationAuthorization: Bearer arc_test_...Keep environment-specific keys server-side.

              
Mutation retryIdempotency-Key retained for 24 hoursReuse the same key for a replay of the same request.

              
Rate limit429 with reset and retry headersBack off and retry after the advertised window.

              
Validation422 validation_failed with field violationsCorrect the rejected fields; do not retry unchanged.

              
Transient failure408 / 425 / 5xxRetry with exponential backoff only when replay-safe.

            
          

        

      

    


    

      

        
Evaluation posture
Test real routes with bounded access
  • Separate test keys and quota
  • Real scoring and batch assessment
  • No active corridor monitors in test
  • Manual evaluation approval

        
Intended use
Decision support, with explicit limits
  • No raw third-party feed redistribution
  • No navigation or safety advice
  • No legal, insurance, or sanctions-compliance determination
  • Verify operational decisions against authoritative notices

      

    


    

      

        
Evaluation access
Test the API in your workflow
Describe where the result would enter your product. Requests are reviewed manually and approved keys are isolated to a bounded test environment.
Human documentation and the OpenAPI contract are public before access.