Skip to main content
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'
{
  "scanId": "scan_01HLMN",
  "awb": "157-12345678",
  "status": "sent"
}

​
Reference Documentation

For more information on security scan transmission to customs, please refer to:

Authorizations

​
Authorization
string
header
required

Body

multipart/form-data
​
awbNumber
string
required
Example:

"157-12345678"

​
scanType
string
required
Example:

"XRAY"

​
scanResult
string
required
Example:

"CLEAR"

​
performedAt
string<date-time>
required
Example:

"2024-01-01T12:00:00Z"

​
image
file
required

X-ray scan image file

Response

201 - application/json

Scan Sent to Customs

​
scanId
string
Example:

"scan_01HLMN"

​
awb
string
Example:

"157-12345678"

​
status
string
Example:

"sent"