Skip to content

Customs Declaration

A document to enable a declarant to indicate the customs procedure to be applied to the goods.

Data Model

CustomsDeclarationCredential＜＜vtd.VerifiableCredential＞＞issuer:PartyissuanceDate:DateTimecredentialSubject:CustomsDeclarationCustomsDeclaration＜＜vtd.CredentialSubject＞＞documentIdentifier:TextbookingReferenceNumber:TextcustomsDeclarationReference:TexttransportDocumentNumber:TextuniqueConsignmentReference:TextinvoiceNumber:TextissueDate:DateactualArrivalDate:DateestimatedTimeOfDeparture:DateactualDepartureDate:DateconsignmentLoadingDate:DateestimatedTimeOfArrival:DateinvoiceDate:Datebuyer:Buyerimporter:Importerexporter:ExporterconsignmentRoute:TextcustomsOfficeOfEntry:CustomsOfficeOfEntrycarrier:Carrierconsignee:ConsigneeshipToParty:ShipToPartywarehouse:WarehousenotifyParty:NotifyPartyconsignor:Consignerseller:SellerinsuranceCompany:InsuranceCompanyexitCustomsOffice:ExitCustomsOfficeexportationCountry:ExportationCountryoriginCountry:OriginCountryarrivalLocation:ArrivalLocationplaceOfIssue:PlaceOfIssueclauses:Clausesterms:TermscustomsValue:CustomsValueBuyer＜＜vtd.Party＞＞id:URIaddress:AddressImporter＜＜vtd.Party＞＞id:URIaddress:AddressExporter＜＜vtd.Party＞＞id:URIaddress:AddressCustomsOfficeOfEntry＜＜vtd.Party＞＞id:URIaddress:AddressCarrier＜＜vtd.Party＞＞id:URIaddress:AddressConsignee＜＜vtd.Party＞＞id:URIaddress:AddressShipToParty＜＜vtd.Party＞＞id:URIaddress:AddressWarehouse＜＜vtd.Party＞＞id:URIaddress:AddressNotifyParty＜＜vtd.Party＞＞id:URIaddress:AddressConsigner＜＜vtd.Party＞＞id:URIaddress:AddressSeller＜＜vtd.Party＞＞id:URIaddress:AddressInsuranceCompany＜＜vtd.Party＞＞id:URIaddress:AddressExitCustomsOffice＜＜vtd.Location＞＞unlocode:URIaddress:AddressExportationCountry＜＜vtd.Location＞＞unlocode:URIaddress:AddressOriginCountry＜＜vtd.Location＞＞unlocode:URIaddress:AddressArrivalLocation＜＜vtd.Location＞＞unlocode:URIaddress:AddressPlaceOfIssue＜＜vtd.Location＞＞unlocode:URIaddress:Addresscountry:TextClauses＜＜vtd.Clauses＞＞transportContractDocumentConditions:Textauthentication:TextTerms＜＜vtd.Terms＞＞terms:TexttradeTermsConditionsDescription:TexttradeTermsConditionsCode:TextpaymentMethod:TextCustomsValue＜＜vtd.MonetaryAmount＞＞amount:Decimalvalue:Decimalcurrency:Text

Example

{
  "issuer": {
    "id": "https://jargon.sh",
    "address": {
      "street": "The quick brown fox jumps over the lazy dog.",
      "city": "The quick brown fox jumps over the lazy dog.",
      "state": "The quick brown fox jumps over the lazy dog.",
      "zip": 12345
    }
  },
  "issuanceDate": "1970-01-01T00:00:00Z",
  "credentialSubject": {
    "documentIdentifier": "The quick brown fox jumps over the lazy dog.",
    "bookingReferenceNumber": "The quick brown fox jumps over the lazy dog.",
    "customsDeclarationReference": "The quick brown fox jumps over the lazy dog.",
    "transportDocumentNumber": "The quick brown fox jumps over the lazy dog.",
    "uniqueConsignmentReference": "The quick brown fox jumps over the lazy dog.",
    "invoiceNumber": "The quick brown fox jumps over the lazy dog.",
    "issueDate": "1970-01-01",
    "actualArrivalDate": "1970-01-01",
    "estimatedTimeOfDeparture": "1970-01-01",
    "actualDepartureDate": "1970-01-01",
    "consignmentLoadingDate": "1970-01-01",
    "estimatedTimeOfArrival": "1970-01-01",
    "invoiceDate": "1970-01-01",
    "buyer": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "importer": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "exporter": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "consignmentRoute": "The quick brown fox jumps over the lazy dog.",
    "customsOfficeOfEntry": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "carrier": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "consignee": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "shipToParty": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "warehouse": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "notifyParty": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "consignor": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "seller": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "insuranceCompany": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "exitCustomsOffice": {
      "unlocode": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "exportationCountry": {
      "unlocode": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "originCountry": {
      "unlocode": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "arrivalLocation": {
      "unlocode": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "placeOfIssue": {
      "unlocode": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      },
      "country": "The quick brown fox jumps over the lazy dog."
    },
    "clauses": {
      "transportContractDocumentConditions": "The quick brown fox jumps over the lazy dog.",
      "authentication": "The quick brown fox jumps over the lazy dog."
    },
    "terms": {
      "terms": "The quick brown fox jumps over the lazy dog.",
      "tradeTermsConditionsDescription": "The quick brown fox jumps over the lazy dog.",
      "tradeTermsConditionsCode": "The quick brown fox jumps over the lazy dog.",
      "paymentMethod": "The quick brown fox jumps over the lazy dog."
    },
    "customsValue": {
      "amount": 3.141579,
      "value": 3.141579,
      "currency": "The quick brown fox jumps over the lazy dog."
    }
  }
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "issuer": {
      "$ref": "#/$defs/Party",
      "description": ""
    },
    "issuanceDate": {
      "type": "string",
      "format": "date-time",
      "description": ""
    },
    "credentialSubject": {
      "$ref": "#/$defs/CustomsDeclaration",
      "description": ""
    }
  },
  "description": "",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "Party": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Address": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "street": {
          "type": "string",
          "description": "The street component of the address"
        },
        "city": {
          "type": "string",
          "description": "The city compomnent of the address"
        },
        "state": {
          "type": "string",
          "description": "The state component of the address"
        },
        "zip": {
          "type": "number",
          "description": "Zip or postal code for the address"
        }
      },
      "description": ""
    },
    "CustomsDeclaration": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "documentIdentifier": {
          "type": "string",
          "description": ""
        },
        "bookingReferenceNumber": {
          "type": "string",
          "description": ""
        },
        "customsDeclarationReference": {
          "type": "string",
          "description": ""
        },
        "transportDocumentNumber": {
          "type": "string",
          "description": ""
        },
        "uniqueConsignmentReference": {
          "type": "string",
          "description": ""
        },
        "invoiceNumber": {
          "type": "string",
          "description": ""
        },
        "issueDate": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "actualArrivalDate": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "estimatedTimeOfDeparture": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "actualDepartureDate": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "consignmentLoadingDate": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "estimatedTimeOfArrival": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "invoiceDate": {
          "type": "string",
          "format": "date",
          "description": ""
        },
        "buyer": {
          "$ref": "#/$defs/Buyer",
          "description": ""
        },
        "importer": {
          "$ref": "#/$defs/Importer",
          "description": ""
        },
        "exporter": {
          "$ref": "#/$defs/Exporter",
          "description": ""
        },
        "consignmentRoute": {
          "type": "string",
          "description": ""
        },
        "customsOfficeOfEntry": {
          "$ref": "#/$defs/CustomsOfficeOfEntry",
          "description": ""
        },
        "carrier": {
          "$ref": "#/$defs/Carrier",
          "description": ""
        },
        "consignee": {
          "$ref": "#/$defs/Consignee",
          "description": ""
        },
        "shipToParty": {
          "$ref": "#/$defs/ShipToParty",
          "description": ""
        },
        "warehouse": {
          "$ref": "#/$defs/Warehouse",
          "description": ""
        },
        "notifyParty": {
          "$ref": "#/$defs/NotifyParty",
          "description": ""
        },
        "consignor": {
          "$ref": "#/$defs/Consigner",
          "description": ""
        },
        "seller": {
          "$ref": "#/$defs/Seller",
          "description": ""
        },
        "insuranceCompany": {
          "$ref": "#/$defs/InsuranceCompany",
          "description": ""
        },
        "exitCustomsOffice": {
          "$ref": "#/$defs/ExitCustomsOffice",
          "description": ""
        },
        "exportationCountry": {
          "$ref": "#/$defs/ExportationCountry",
          "description": ""
        },
        "originCountry": {
          "$ref": "#/$defs/OriginCountry",
          "description": ""
        },
        "arrivalLocation": {
          "$ref": "#/$defs/ArrivalLocation",
          "description": ""
        },
        "placeOfIssue": {
          "$ref": "#/$defs/PlaceOfIssue",
          "description": ""
        },
        "clauses": {
          "$ref": "#/$defs/Clauses",
          "description": ""
        },
        "terms": {
          "$ref": "#/$defs/Terms",
          "description": ""
        },
        "customsValue": {
          "$ref": "#/$defs/CustomsValue",
          "description": ""
        }
      },
      "description": ""
    },
    "Buyer": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Importer": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Exporter": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "CustomsOfficeOfEntry": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Carrier": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Consignee": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "ShipToParty": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Warehouse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "NotifyParty": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Consigner": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Seller": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "InsuranceCompany": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "ExitCustomsOffice": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "unlocode": {
          "type": "string",
          "format": "uri",
          "description": ""
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": ""
        }
      },
      "description": ""
    },
    "ExportationCountry": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "unlocode": {
          "type": "string",
          "format": "uri",
          "description": ""
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": ""
        }
      },
      "description": ""
    },
    "OriginCountry": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "unlocode": {
          "type": "string",
          "format": "uri",
          "description": ""
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": ""
        }
      },
      "description": ""
    },
    "ArrivalLocation": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "unlocode": {
          "type": "string",
          "format": "uri",
          "description": ""
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": ""
        }
      },
      "description": ""
    },
    "PlaceOfIssue": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "unlocode": {
          "type": "string",
          "format": "uri",
          "description": ""
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": ""
        },
        "country": {
          "type": "string",
          "description": ""
        }
      },
      "description": ""
    },
    "Clauses": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transportContractDocumentConditions": {
          "type": "string",
          "description": ""
        },
        "authentication": {
          "type": "string",
          "description": ""
        }
      },
      "description": ""
    },
    "Terms": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "terms": {
          "type": "string",
          "description": ""
        },
        "tradeTermsConditionsDescription": {
          "type": "string",
          "description": ""
        },
        "tradeTermsConditionsCode": {
          "type": "string",
          "description": ""
        },
        "paymentMethod": {
          "type": "string",
          "description": ""
        }
      },
      "description": ""
    },
    "CustomsValue": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "format": "float",
          "description": ""
        },
        "value": {
          "type": "number",
          "format": "float",
          "description": ""
        },
        "currency": {
          "type": "string",
          "description": ""
        }
      },
      "description": ""
    }
  }
}