Portbase

Portbase Port Authority API

The Port Authority API API from Portbase — 18 operation(s) for port authority api.

GitHub OpenAPI

Operations 18

POST /acceptHealth Accept health #
POST /acceptSecurity Accept security #
POST /acceptVisit Accept visit #
POST /acceptWaste Accept waste #
POST /addBerthVisitAfter Add berth visit #
POST /changeBertVisitLocation Change berth visit location #
POST /acceptDangerousGoods Accept dangerous goods #
POST /processAta Register ATA (old) #
POST /processAtd Register ATD (old) #
POST /processAtdPort Register ATD port #
POST /registerAta Register ATA #
POST /registerAtd Register ATD #
POST /rejectDangerousGoods Reject dangerous goods #
POST /rejectHealth Reject health #
POST /rejectSecurity Reject security #
POST /rejectVisit Reject visit #
POST /rejectWaste Reject waste #
POST /declarationResponse Respond to declaration #

Documentation

📖
Documentation
https://api.cargo-controller-export.pcs.portbase.com/api/public/index.html
📖
GettingStarted
https://support.portbase.com/hc/en-gb/articles/34948493768466-Creating-a-system-interface-API-with-Cargo-Controller-Export
📖
Documentation
https://cargo-controller.pcs.portbase.com/api/public/index.html
📖
GettingStarted
https://support.portbase.com/hc/en-gb/articles/29522670809746-Create-a-system-interface-API-with-Cargo-Controller-Import
📖
Documentation
https://hcn.pcs.portbase.com/api-documentation/index.html
📖
GettingStarted
https://support.portbase.com/hc/en-gb/articles/29950155564562-Create-a-system-interface-API-with-Hinterland-Container-Notification-Barge-Rail-or-Road
📖
Documentation
https://portvisit.pcs.portbase.com/api-documentation/index.html
📖
GettingStarted
https://support.portbase.com/hc/en-gb/articles/29950455304594-Create-system-interface-with-Vessel-Notification

Specifications

⚙
OpenAPI
https://artifacts.apis.io/portbase/openapi/portbase-port-authority-api-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-booking-dossier-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-subscribe-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-subscription-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-track-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-api-organisation-bl-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-shipment-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-transfer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-batch-track-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-terminal-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-equipment-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-equipment-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-container-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-get-road-voyage-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-get-hinterland-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-external-visit-api-visit-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-common-authentication-bezoekschip-organisation-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-commercialrelease-input-input-commercial-release-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-common-get-any-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-visit-get-visit-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-import-consignment-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/portbase:portbase-port-authority-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

portbase-port-authority-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Portbase Port Authority API
  version: '6.0'
  contact:
    name: Portbase portvisit team
    url: https://portvisit.pcs.portbase.com
    email: customerservice@portbase.com
  x-logo:
    url: Portbase_WB_RGB.png
    altText: Portbase logo
  description: 'Operations tagged Port Authority API across 2 of this provider''s published API definitions: portbase-portvisit-v6.json, portbase-vessel-visit-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.portbase.com/portvisit
  description: Production server
- url: https://api.kt.portbase.com/portvisit
  description: Acceptance server
- url: https://api.sc.portbase.com/portvisit
  description: Test server
tags:
- name: Port Authority API
paths:
  /acceptHealth:
    post:
      tags:
      - Port Authority API
      summary: Accept health
      description: This endpoint can be used to accept a health declaration as Port Authority.
      operationId: acceptHealth
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiAcceptDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /acceptSecurity:
    post:
      tags:
      - Port Authority API
      summary: Accept security
      description: This endpoint can be used to accept a security declaration as Port Authority.
      operationId: acceptSecurity
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiAcceptDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /acceptVisit:
    post:
      tags:
      - Port Authority API
      summary: Accept visit
      description: This endpoint can be used to accept a visit declaration as Port Authority.
      operationId: acceptVisit
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiAcceptDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /acceptWaste:
    post:
      tags:
      - Port Authority API
      summary: Accept waste
      description: This endpoint can be used to accept a waste declaration as Port Authority.
      operationId: acceptWaste
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiAcceptDeclaration'
      responses:
        '204':
          description: successful operation
      deprecated: true
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /addBerthVisitAfter:
    post:
      tags:
      - Port Authority API
      summary: Add berth visit
      description: Inserts a berth visit after the given berth visit or at the start if no berthVisitId is given.
      operationId: addBerthVisitAfter
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiProcessAddBerthVisitAfter'
      responses:
        '200':
          description: successful operation, returns the id of the berth visit that was inserted.
          content:
            application/json:
              schema:
                type: string
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /changeBertVisitLocation:
    post:
      tags:
      - Port Authority API
      summary: Change berth visit location
      description: Set the location of a berth visit to a different berth
      operationId: changeBertVisitLocation
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiChangeBerthVisitLocation'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /acceptDangerousGoods:
    post:
      tags:
      - Port Authority API
      summary: Accept dangerous goods
      description: This endpoint can be used to accept a dangerous goods declaration as Port Authority.
      operationId: p07acceptDangerousGoods
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiAcceptDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /processAta:
    post:
      tags:
      - Port Authority API
      summary: Register ATA (old)
      description: This endpoint can be used to register an ATA for a berth visit as Port Authority. Use registerAta instead
      operationId: processAta
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiProcessAta'
      responses:
        '204':
          description: successful operation
      deprecated: true
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /processAtd:
    post:
      tags:
      - Port Authority API
      summary: Register ATD (old)
      description: This endpoint can be used to register an ATD for a berth visit as Port Authority. Use registerAtd instead
      operationId: processAtd
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiProcessAtd'
      responses:
        '204':
          description: successful operation
      deprecated: true
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /processAtdPort:
    post:
      tags:
      - Port Authority API
      summary: Register ATD port
      description: This endpoint can be used to register an ATD for the port visit as Port Authority.
      operationId: processAtd_1
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRegisterAtdPort'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /registerAta:
    post:
      tags:
      - Port Authority API
      summary: Register ATA
      description: This endpoint can be used to register an ATA for a berth visit as Port Authority.
      operationId: registerAta
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRegisterActualTime'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /registerAtd:
    post:
      tags:
      - Port Authority API
      summary: Register ATD
      description: This endpoint can be used to register an ATD for a berth visit as Port Authority.
      operationId: registerAtd
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRegisterActualTime'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /rejectDangerousGoods:
    post:
      tags:
      - Port Authority API
      summary: Reject dangerous goods
      description: This endpoint can be used to reject a dangerous goods declaration as Port Authority.
      operationId: rejectDangerousGoods
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRejectDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /rejectHealth:
    post:
      tags:
      - Port Authority API
      summary: Reject health
      description: This endpoint can be used to reject a health declaration as Port Authority.
      operationId: rejectHealth
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRejectDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /rejectSecurity:
    post:
      tags:
      - Port Authority API
      summary: Reject security
      description: This endpoint can be used to reject a security declaration as Port Authority.
      operationId: rejectSecurity
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRejectDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /rejectVisit:
    post:
      tags:
      - Port Authority API
      summary: Reject visit
      description: This endpoint can be used to reject a visit declaration as Port Authority.
      operationId: rejectVisit
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRejectDeclaration'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /rejectWaste:
    post:
      tags:
      - Port Authority API
      summary: Reject waste
      description: This endpoint can be used to reject a waste declaration as Port Authority.
      operationId: rejectWaste
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.adapter.ApiRejectDeclaration'
      responses:
        '204':
          description: successful operation
      deprecated: true
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /declarationResponse:
    post:
      tags:
      - Port Authority API
      summary: Respond to declaration
      description: This endpoint can be used to accept or reject a declaration as Port Authority.
      operationId: respond
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.messaging.DeclarationResponse'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
components:
  schemas:
    com.portbase.bezoekschip.adapter.ApiProcessAddBerthVisitAfter:
      title: ProcessAddBerthVisitAfter
      required:
      - berthCode
      - crn
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        berthVisitId:
          type:
          - string
          - 'null'
          description: The ID of the berth visit after which the new berth visit should be inserted, or null to insert a berth visit at port arrival
        berthCode:
          type: string
          description: The berth code
        accept:
          type: boolean
          description: Set this to also accept the visit
    com.portbase.bezoekschip.adapter.ApiProcessAtd:
      title: ProcessAtd
      required:
      - berthCode
      - crn
      - timestamp
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        berthCode:
          type: string
          description: The berth code
        timestamp:
          type: string
          description: The time of departure of the vessel from the berth
          format: date-time
        lastBerth:
          type: boolean
          description: Flag that indicates whether or not this is the last berth on the visit
    com.portbase.bezoekschip.adapter.ApiProcessAta:
      title: ProcessAta
      required:
      - berthCode
      - crn
      - timestamp
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        berthCode:
          type: string
          description: The berth code
        timestamp:
          type: string
          description: The time of arrival of the vessel at the berth
          format: date-time
    com.portbase.bezoekschip.adapter.ApiRejectDeclaration:
      title: RejectDeclaration
      required:
      - crn
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        reason:
          type:
          - string
          - 'null'
          description: The reason for rejection
    com.portbase.bezoekschip.adapter.ApiAcceptDeclaration:
      title: AcceptDeclaration
      required:
      - crn
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
    com.portbase.bezoekschip.common.api.messaging.DeclarationResponse:
      title: DeclarationResponse
      required:
      - accepted
      - crn
      - declarationId
      - declarationType
      type: object
      properties:
        accepted:
          type: boolean
        rejectionReason:
          type:
          - string
          - 'null'
        crn:
          minLength: 1
          type: string
        declarationId:
          minLength: 1
          type: string
        declarationType:
          type: string
    com.portbase.bezoekschip.adapter.ApiRegisterActualTime:
      title: RegisterActualTime
      required:
      - berthVisitId
      - crn
      - timestamp
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        berthVisitId:
          type: string
          description: The berth visit ID
        timestamp:
          type: string
          description: The actual time of arrival or the actual time of departure of the vessel at the berth
          format: date-time
    com.portbase.bezoekschip.adapter.ApiRegisterAtdPort:
      title: RegisterAtdPort
      required:
      - atdPort
      - crn
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        atdPort:
          type: string
          format: date-time
    com.portbase.bezoekschip.adapter.ApiChangeBerthVisitLocation:
      title: ChangeBerthVisitLocation
      required:
      - berthCode
      - berthVisitId
      - crn
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The call reference number of the visit
        berthVisitId:
          type: string
          description: The berth visit ID
        berthCode:
          type: string
          description: The berth code of the new location for this berth visit
x-refined-from:
- portbase-portvisit-v6.json
- portbase-vessel-visit-openapi.yml