castomAPI
Get your key
POST /v1/verify/container-imo free No key needed Verify

Verify ISO 6346 shipping container numbers (owner code

Verify ISO 6346 shipping container numbers (owner code, equipment category, Modulo 11 check digit) and IMO vessel numbers (Modulo 10 check digit)

POST

Request

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Response

{
  "containerResult": {
    "checkDigit": "<check digit>",
    "equipmentCategoryCode": "ABC-123",
    "equipmentCategoryDescription": "Generated from the endpoint's own schema.",
    "formattedPrint": "PL61 1090 1014 0000 0712 1981 2874",
    "isValid": true,
    "normalized": "PL61109010140000071219812874",
    "ownerCode": "ABC-123",
    "rawInput": "PL61109010140000071219812874",
    "reason": "checksum ok",
    "serialNumber": "<serial number>"
  },
  "imoResult": {
    "checkDigit": "<check digit>",
    "formattedPrint": "PL61 1090 1014 0000 0712 1981 2874",
    "isValid": true,
    "normalized": "PL61109010140000071219812874",
    "rawInput": "PL61109010140000071219812874",
    "reason": "checksum ok",
    "sequentialNumber": "<sequential number>"
  },
  "isValid": true,
  "status": "success",
  "tokensDeducted": 1
}
The response below is a mock built from the endpoint's own schema — no request leaves this page. Edit the body, press Send, read the shape you will get back. Run it for real in the dashboard →

What it does

Verify ISO 6346 shipping container numbers (owner code, equipment category, Modulo 11 check digit) and IMO vessel numbers (Modulo 10 check digit)

Request

Body

FieldTypeRequiredDescription
containerNumberstringnoISO 6346 shipping container number (e.g. "CSQU3054383" or "CSQU 305438 3")
identifierstringnoAuto-detected single identifier (auto-routes to Container or IMO verification)
imoNumberstringnoIMO vessel identification number (e.g. "IMO 9176187" or "9176187")

Example request

{
  "containerNumber": "CSQU3054383",
  "identifier": "<identifier>",
  "imoNumber": "9074729"
}

Response

FieldTypeDescription
containerResultobject
  ↳ checkDigitstring
  ↳ equipmentCategoryCodestring
  ↳ equipmentCategoryDescriptionstring
  ↳ formattedPrintstring
  ↳ isValidboolean
  ↳ normalizedstring
  ↳ ownerCodestring
  ↳ rawInputstring
  ↳ reasonstring
  ↳ serialNumberstring
imoResultobject
  ↳ checkDigitstring
  ↳ formattedPrintstring
  ↳ isValidboolean
  ↳ normalizedstring
  ↳ rawInputstring
  ↳ reasonstring
  ↳ sequentialNumberstring
isValidboolean
statusstring
tokensDeductedinteger

Example response

{
  "containerResult": {
    "checkDigit": "<check digit>",
    "equipmentCategoryCode": "ABC-123",
    "equipmentCategoryDescription": "Generated from the endpoint's own schema.",
    "formattedPrint": "PL61 1090 1014 0000 0712 1981 2874",
    "isValid": true,
    "normalized": "PL61109010140000071219812874",
    "ownerCode": "ABC-123",
    "rawInput": "PL61109010140000071219812874",
    "reason": "checksum ok",
    "serialNumber": "<serial number>"
  },
  "imoResult": {
    "checkDigit": "<check digit>",
    "formattedPrint": "PL61 1090 1014 0000 0712 1981 2874",
    "isValid": true,
    "normalized": "PL61109010140000071219812874",
    "rawInput": "PL61109010140000071219812874",
    "reason": "checksum ok",
    "sequentialNumber": "<sequential number>"
  },
  "isValid": true,
  "status": "success",
  "tokensDeducted": 1
}

Errors

Every error answers with the same envelope: an HTTP status, a machine code and a sentence.

400The body or a parameter failed validation. The details array names the field.
401No key, a revoked key or a wrong header. Send x-api-key.
402The wallet cannot cover this call. Top up or wait for the monthly grant.
404The resource does not exist, or it is not yours. Both answer identically and cost nothing.
429Over the per-minute quota of your tier. Back off and retry.
5xxUpstream refused or timed out. The call is not billed.

Code

curl -X POST 'https://app.castomapi.com/v1/verify/container-imo' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"containerNumber": "CSQU3054383", "identifier": "<identifier>", "imoNumber": "9074729"}'
const res = await fetch('https://app.castomapi.com/v1/verify/container-imo', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"containerNumber": "CSQU3054383", "identifier": "<identifier>", "imoNumber": "9074729"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/verify/container-imo', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"containerNumber": "CSQU3054383", "identifier": "<identifier>", "imoNumber": "9074729"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/verify/container-imo',
    headers={'x-api-key': '<your-api-key>'},
    json={"containerNumber": "CSQU3054383", "identifier": "<identifier>", "imoNumber": "9074729"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/verify/container-imo');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['containerNumber' => 'CSQU3054383', 'identifier' => '<identifier>', 'imoNumber' => '9074729']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Cost and limits

This operation needs no API key and costs nothing: called without a key it answers 200 and deducts zero tokens, up to 10 requests a minute per IP address.

Rate limits per minute

No key10
Free60
Pro300
Enterprise1200

Docs → Pricing

Questions

What does Verify ISO 6346 shipping container numbers (owner code cost?

This operation needs no API key and costs nothing: called without a key it answers 200 and deducts zero tokens, up to 10 requests a minute per IP address.

How do I authenticate?

Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.

Can I send an Authorization: Bearer token instead?

Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.

What are the limits?

10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.

OpenAPI: https://app.castomapi.com/docs/json