Send Security Scan (X-ray) to Customs
curl --request POST \
--url https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans \
--header 'Authorization: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--form awbNumber=157-12345678 \
--form scanType=XRAY \
--form scanResult=CLEAR \
--form performedAt=2024-01-01T12:00:00Z \
--form image='@example-file'import requests
url = "https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans"
files = { "image": ("example-file", open("example-file", "rb")) }
payload = {
"awbNumber": "157-12345678",
"scanType": "XRAY",
"scanResult": "CLEAR",
"performedAt": "2024-01-01T12:00:00Z"
}
headers = {"Authorization": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('awbNumber', '157-12345678');
form.append('scanType', 'XRAY');
form.append('scanResult', 'CLEAR');
form.append('performedAt', '2024-01-01T12:00:00Z');
form.append('image', '<string>');
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
options.body = form;
fetch('https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans")
.header("Authorization", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"scanId": "scan_01HLMN",
"awb": "157-12345678",
"status": "sent"
}Operational Events & Manifests
Send Security Scan (X-ray) to Customs
Transmit x-ray scan metadata + image to Customs.
POST
/
api
/
security
/
scans
Send Security Scan (X-ray) to Customs
curl --request POST \
--url https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans \
--header 'Authorization: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--form awbNumber=157-12345678 \
--form scanType=XRAY \
--form scanResult=CLEAR \
--form performedAt=2024-01-01T12:00:00Z \
--form image='@example-file'import requests
url = "https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans"
files = { "image": ("example-file", open("example-file", "rb")) }
payload = {
"awbNumber": "157-12345678",
"scanType": "XRAY",
"scanResult": "CLEAR",
"performedAt": "2024-01-01T12:00:00Z"
}
headers = {"Authorization": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('awbNumber', '157-12345678');
form.append('scanType', 'XRAY');
form.append('scanResult', 'CLEAR');
form.append('performedAt', '2024-01-01T12:00:00Z');
form.append('image', '<string>');
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
options.body = form;
fetch('https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans")
.header("Authorization", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/security/scans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"awbNumber\"\r\n\r\n157-12345678\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanType\"\r\n\r\nXRAY\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scanResult\"\r\n\r\nCLEAR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"performedAt\"\r\n\r\n2024-01-01T12:00:00Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"scanId": "scan_01HLMN",
"awb": "157-12345678",
"status": "sent"
}Reference Documentation
For more information on security scan transmission to customs, please refer to:
- Pages 197-198 of “Functional_Requirements_V18 FINAL”: https://belli.sg/4hrqpTT
Authorizations
ApiKeyAuthApiKeyHeader
Body
multipart/form-data
⌘I