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)
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
}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
| Field | Type | Required | Description |
|---|---|---|---|
containerNumber | string | no | ISO 6346 shipping container number (e.g. "CSQU3054383" or "CSQU 305438 3") |
identifier | string | no | Auto-detected single identifier (auto-routes to Container or IMO verification) |
imoNumber | string | no | IMO vessel identification number (e.g. "IMO 9176187" or "9176187") |
Example request
{
"containerNumber": "CSQU3054383",
"identifier": "<identifier>",
"imoNumber": "9074729"
}Response
| Field | Type | Description |
|---|---|---|
containerResult | object | |
↳ checkDigit | string | |
↳ equipmentCategoryCode | string | |
↳ equipmentCategoryDescription | string | |
↳ formattedPrint | string | |
↳ isValid | boolean | |
↳ normalized | string | |
↳ ownerCode | string | |
↳ rawInput | string | |
↳ reason | string | |
↳ serialNumber | string | |
imoResult | object | |
↳ checkDigit | string | |
↳ formattedPrint | string | |
↳ isValid | boolean | |
↳ normalized | string | |
↳ rawInput | string | |
↳ reason | string | |
↳ sequentialNumber | string | |
isValid | boolean | |
status | string | |
tokensDeducted | integer |
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.
400 | The body or a parameter failed validation. The details array names the field. |
401 | No key, a revoked key or a wrong header. Send x-api-key. |
402 | The wallet cannot cover this call. Top up or wait for the monthly grant. |
404 | The resource does not exist, or it is not yours. Both answer identically and cost nothing. |
429 | Over the per-minute quota of your tier. Back off and retry. |
5xx | Upstream 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 key | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
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