Export Health Certificates reference data API - Defra API Developer Portal

API

This API enables traders to check reference data needed for export health certificates. This is the first step towards enabling digital integration for moving agri-food goods.

Operations

The following operations are available for this API. Expand the sections to find out more about each, including the parameters and request/response structures.

Get /border-control-post

Find Border Control Posts in Reference Data.

Parameters
Name	Description
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
id	Filter by Id containing value. Data type: string Parameter location: Query Is mandatory: No
schemaName	Filter by SchemaName containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Border Control Posts. Here is an example response for this BorderControlPostPagedResult schema: { "data": [ { "id": { "id": "GBBRS1", "name": "Bristol", "schemaName": "BorderControlPosts" }, "name": "Bristol" } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Border Control Posts.

Here is an example response for this BorderControlPostPagedResult schema:

{
  "data": [
    {
      "id": {
        "id": "GBBRS1",
        "name": "Bristol",
        "schemaName": "BorderControlPosts"
      },
      "name": "Bristol"
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Get /certifier

Find Certifier details in Reference Data.

Parameters
Name	Description
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
postcode	Filter by Postcode containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Certifier details. Here is an example response for this PartyPagedResult schema: { "data": [ { "name": "Nikolaus Nerney", "address": { "postCode": "GU324PJ", "lineOne": "5553 Bobwhite Junction", "lineTwo": "Way Road", "lineThree": "Autumn Leaf Town", "lineFour": "United Kingdom" } } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Certifier details.

Here is an example response for this PartyPagedResult schema:

{
  "data": [
    {
      "name": "Nikolaus Nerney",
      "address": {
        "postCode": "GU324PJ",
        "lineOne": "5553 Bobwhite Junction",
        "lineTwo": "Way Road",
        "lineThree": "Autumn Leaf Town",
        "lineFour": "United Kingdom"
      }
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Get /country

Find Country details in Reference Data.

Parameters
Name	Description
id	Filter by Id containing value. Data type: string Parameter location: Query Is mandatory: No
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Country details. Here is an example response for this CountryPagedResult schema: { "data": [ { "countryId": { "id": "AD", "name": "Andorra", "schemaId": "ISO3166", "agencyId": "ISO", "language": "en" }, "countrySubDivisionId": [ { "id": "AD-07", "name": "Andorra la Vella", "schemaId": "ISO3166-2", "agencyId": "ISO", "language": "en" } ] } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Country details.

Here is an example response for this CountryPagedResult schema:

{
  "data": [
    {
      "countryId": {
        "id": "AD",
        "name": "Andorra",
        "schemaId": "ISO3166",
        "agencyId": "ISO",
        "language": "en"
      },
      "countrySubDivisionId": [
        {
          "id": "AD-07",
          "name": "Andorra la Vella",
          "schemaId": "ISO3166-2",
          "agencyId": "ISO",
          "language": "en"
        }
      ]
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Get /measurement-temperature

Find Measurement Temperature details in Reference Data.

Parameters
Name	Description
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
description	Filter by Description containing value. Data type: string Parameter location: Query Is mandatory: No
code	Filter by Code containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Measurement Temperature data. Here is an example response for this ReferenceDataResultPagedResult schema: { "data": [ { "code": "S2G", "name": "Short name/description reference data", "description": "Long description describing reference data", "language": "en" } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Measurement Temperature data.

Here is an example response for this ReferenceDataResultPagedResult schema:

{
  "data": [
    {
      "code": "S2G",
      "name": "Short name/description reference data",
      "description": "Long description describing reference data",
      "language": "en"
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Get /measurement-weight

Find Measurement Weight in Reference Data.

Parameters
Name	Description
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
description	Filter by Description containing value. Data type: string Parameter location: Query Is mandatory: No
code	Filter by Code containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Measurement Weight. Here is an example response for this ReferenceDataResultPagedResult schema: { "data": [ { "code": "S2G", "name": "Short name/description reference data", "description": "Long description describing reference data", "language": "en" } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Measurement Weight.

Here is an example response for this ReferenceDataResultPagedResult schema:

{
  "data": [
    {
      "code": "S2G",
      "name": "Short name/description reference data",
      "description": "Long description describing reference data",
      "language": "en"
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Get /metadata

Retrieve a list of Export Health Certificate Reference Data metadata.

Parameters

There are no parameters needed for this operation.

Responses application/json
Code	Description
200	Result of Export Health Certificate Reference Data end points. Here is an example response for this MetadataGet200ApplicationJsonResponse schema: [ { "name": "Certifiers", "description": "Certifiers for EHCO applications", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/certifier", "rel": "certifier", "method": "GET" } ] }, { "name": "Transport Means", "description": "Reference data for Transport Means", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/transport-means", "rel": "transport-means", "method": "GET" } ] }, { "name": "Measurement Temperature", "description": "Reference data for Measurement Temperatures", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/measurement-temperature", "rel": "measurement-temperature", "method": "GET" } ] }, { "name": "Measurement Weight", "description": "Reference data for Measurement Weights", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/measurement-weight", "rel": "measurement-weight", "method": "GET" } ] }, { "name": "Border Control Post", "description": "Reference data for Border Control Posts", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/border-control-post", "rel": "border-control-post", "method": "GET" } ] }, { "name": "Package Type", "description": "Reference data for Package Types", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/package-type", "rel": "package-type", "method": "GET" } ] }, { "name": "Country", "description": "Reference data for countries and sub-divisions", "_links": [ { "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/country", "rel": "country", "method": "GET" } ] } ]
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }

Responses application/json

200

Result of Export Health Certificate Reference Data end points.

Here is an example response for this MetadataGet200ApplicationJsonResponse schema:

[
  {
    "name": "Certifiers",
    "description": "Certifiers for EHCO applications",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/certifier",
        "rel": "certifier",
        "method": "GET"
      }
    ]
  },
  {
    "name": "Transport Means",
    "description": "Reference data for Transport Means",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/transport-means",
        "rel": "transport-means",
        "method": "GET"
      }
    ]
  },
  {
    "name": "Measurement Temperature",
    "description": "Reference data for Measurement Temperatures",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/measurement-temperature",
        "rel": "measurement-temperature",
        "method": "GET"
      }
    ]
  },
  {
    "name": "Measurement Weight",
    "description": "Reference data for Measurement Weights",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/measurement-weight",
        "rel": "measurement-weight",
        "method": "GET"
      }
    ]
  },
  {
    "name": "Border Control Post",
    "description": "Reference data for Border Control Posts",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/border-control-post",
        "rel": "border-control-post",
        "method": "GET"
      }
    ]
  },
  {
    "name": "Package Type",
    "description": "Reference data for Package Types",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/package-type",
        "rel": "package-type",
        "method": "GET"
      }
    ]
  },
  {
    "name": "Country",
    "description": "Reference data for countries and sub-divisions",
    "_links": [
      {
        "href": "https://gateway.trade.defra.gov.uk/trade-sci-reference-data/dev/v1/country",
        "rel": "country",
        "method": "GET"
      }
    ]
  }
]

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

Get /package-type

Find Package Types in Reference Data.

Parameters
Name	Description
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
id	Filter by Id containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Package Types. Here is an example response for this PackagePagedResult schema: { "data": [ { "type": { "id": "43", "name": "Bag, super bulk", "language": "en" } } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Package Types.

Here is an example response for this PackagePagedResult schema:

{
  "data": [
    {
      "type": {
        "id": "43",
        "name": "Bag, super bulk",
        "language": "en"
      }
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Get /transport-means

Find Transport Means in Reference Data.

Parameters
Name	Description
name	Filter by Name containing value. Data type: string Parameter location: Query Is mandatory: No
description	Filter by Description containing value. Data type: string Parameter location: Query Is mandatory: No
code	Filter by Code containing value. Data type: string Parameter location: Query Is mandatory: No
pageNumber	Format - int64. Page number to return. Data type: integer Parameter location: Query Is mandatory: No
pageSize	Format - int64. Number of items per page. Data type: integer Parameter location: Query Is mandatory: No

Responses application/json
Code	Description
400	Request failed validation. Errors can be found in the response body. Here is an example response for this CommonProblemDetails schema: { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "traceId": "\|2828f51e-43537e121ef735a3.", "errors": { "pageSize": [ "Page Size must be greater than or equal to '1'." ] } }
200	Paged result of Transport Means. Here is an example response for this ReferenceDataResultPagedResult schema: { "data": [ { "code": "S2G", "name": "Short name/description reference data", "description": "Long description describing reference data", "language": "en" } ], "records": 1, "pageNumber": 1, "pageSize": 10, "totalRecords": 1, "totalPages": 1 }

Responses application/json

400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "|2828f51e-43537e121ef735a3.",
  "errors": {
    "pageSize": [
      "Page Size must be greater than or equal to '1'."
    ]
  }
}

200

Paged result of Transport Means.

Here is an example response for this ReferenceDataResultPagedResult schema:

{
  "data": [
    {
      "code": "S2G",
      "name": "Short name/description reference data",
      "description": "Long description describing reference data",
      "language": "en"
    }
  ],
  "records": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 1,
  "totalPages": 1
}

Schemas

The following section shows the model definitions that are used by the operations above when sending and receiving data to the API.

Address

Address details.

Property	Value
postCode	Postcode. Data type: string Is mandatory: No
coordinates	Geographic co-ordinates. Data type: object using the model Coordinates Is mandatory: No
what3Words	What 3 Words location identifier details. Data type: object using the model What3Words Is mandatory: No
unlocode	United Nations Code for Trade and Transport Locations. Data type: string Is mandatory: No
lineOne	Address line one. Data type: string Is mandatory: No
lineTwo	Address line two. Data type: string Is mandatory: No
lineThree	Address line three. Data type: string Is mandatory: No
lineFour	Address line four. Data type: string Is mandatory: No
lineFive	Address line five. Data type: string Is mandatory: No
city	City. Data type: string Is mandatory: No
country	Country details. Data type: object using the model Country Is mandatory: No
approvalNumber	A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information. Data type: object using the model TradeIdentifier Is mandatory: No

BorderControlPost

Border control post information.

Property	Value
id	A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information. Data type: object using the model TradeIdentifier Is mandatory: No
name	Name of the BCP. Data type: string Is mandatory: No

Property

Value

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.

Data type: object using the model TradeIdentifier
Is mandatory: No

name

Name of the BCP.

Data type: string
Is mandatory: No

BorderControlPostPagedResult

Paginated response from the API.

Property	Value
data	Specified page within the data set. Data type: array [object] using the model BorderControlPost Is mandatory: No
records	Number of records in the current page. Data type: integer with format int64 For example: 1 Is mandatory: No
pageNumber	Page number. Data type: integer with format int64 For example: 1 Is mandatory: No
pageSize	Page size. Data type: integer with format int64 For example: 10 Is mandatory: No
totalRecords	Total number of records across all pages. Data type: integer with format int64 For example: 1 Is mandatory: No
totalPages	Total number of pages. Data type: integer with format int64 For example: 1 Is mandatory: No

CommonProblemDetails

Common API problem format for describing system and user error HTTP API responses based on https://tools.ietf.org/html/rfc7807.

Property	Value
type	A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". Data type: string Is mandatory: No
title	A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see[RFC7231], Section 3.4). Data type: string Is mandatory: No
status	The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. Data type: integer with format int32 Is mandatory: No
detail	A human-readable explanation specific to this occurrence of the problem. Data type: string Is mandatory: No
instance	A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced. Data type: string Is mandatory: No
errors	Errors associated with the request. Is mandatory: No

ContactDetail

Person contact detail.

Property	Value
phoneNumber	Contact telephone number. Data type: string Is mandatory: No
emailAddress	Contact email address. Data type: string Is mandatory: No

Coordinates

Geographic co-ordinates.

Property	Value
latitude	Latitude. Data type: number with format double For example: 51.509865 Is mandatory: No
longitude	Longitude. Data type: number with format double For example: -0.118092 Is mandatory: No

Country

Country details.

Property	Value
countryId	A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information. Data type: object using the model TradeIdentifier Is mandatory: No
countrySubDivisionId	ISO country sub division code identifier. Data type: array [object] using the model TradeIdentifier Is mandatory: No
market	The trading market / block the country is part of. Data type: string Is mandatory: No

CountryPagedResult

Paginated response from the API.

Property	Value
data	Specified page within the data set. Data type: array [object] using the model Country Is mandatory: No
records	Number of records in the current page. Data type: integer with format int64 For example: 1 Is mandatory: No
pageNumber	Page number. Data type: integer with format int64 For example: 1 Is mandatory: No
pageSize	Page size. Data type: integer with format int64 For example: 10 Is mandatory: No
totalRecords	Total number of records across all pages. Data type: integer with format int64 For example: 1 Is mandatory: No
totalPages	Total number of pages. Data type: integer with format int64 For example: 1 Is mandatory: No

DatasetMetadata

Reference Data meta-data.

Property	Value
_links	Hypermedia as the Engine of Application State (HATEOAS) links to related resources. Data type: array [object] using the model ResourceLink Is mandatory: No
name	Reference Data name. Data type: string For example: Name Is mandatory: No
description	Description. Data type: string For example: Summary description Is mandatory: No

Measure

A numeric value determined by measuring an object along with the specified unit of measure.

Property	Value
value	The numeric value determined by measuring an object. Data type: number with format double Is mandatory: No
unit	Type of unit describing the measure. Data type: string Is mandatory: No
version	The version of the measure unit code list. Data type: string Is mandatory: No
measureNote	Information or additional detail regarding the measure. Data type: string Is mandatory: No

MetadataGet200ApplicationJsonResponse

Property	Value

Package

A physical package for a trade line item.

Property	Value
level	A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information. Data type: object using the model TradeIdentifier Is mandatory: No
type	A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information. Data type: object using the model TradeIdentifier Is mandatory: No
itemQuantity	A numeric value determined by measuring an object along with the specified unit of measure. Data type: object using the model Measure Is mandatory: No
nominalGrossWeight	A numeric value determined by measuring an object along with the specified unit of measure. Data type: object using the model Measure Is mandatory: No
nominalGrossVolume	A numeric value determined by measuring an object along with the specified unit of measure. Data type: object using the model Measure Is mandatory: No

PackagePagedResult

Paginated response from the API.

Property	Value
data	Specified page within the data set. Data type: array [object] using the model Package Is mandatory: No
records	Number of records in the current page. Data type: integer with format int64 For example: 1 Is mandatory: No
pageNumber	Page number. Data type: integer with format int64 For example: 1 Is mandatory: No
pageSize	Page size. Data type: integer with format int64 For example: 10 Is mandatory: No
totalRecords	Total number of records across all pages. Data type: integer with format int64 For example: 1 Is mandatory: No
totalPages	Total number of pages. Data type: integer with format int64 For example: 1 Is mandatory: No

Party

The definition of a responsible party in the chain.

Property	Value
uid	Identifier the party is known by. Data type: array [object] using the model TradeIdentifier Is mandatory: No
name	Name of the party. Data type: string For example: Is mandatory: No
address	Address details. Data type: object using the model Address Is mandatory: No
contact	Details of relevant persons at the Party. Data type: array [object] using the model Person Is mandatory: No
specifiedPerson	Persons details. Data type: object using the model Person Is mandatory: No

PartyPagedResult

Paginated response from the API.

Property	Value
data	Specified page within the data set. Data type: array [object] using the model Party Is mandatory: No
records	Number of records in the current page. Data type: integer with format int64 For example: 1 Is mandatory: No
pageNumber	Page number. Data type: integer with format int64 For example: 1 Is mandatory: No
pageSize	Page size. Data type: integer with format int64 For example: 10 Is mandatory: No
totalRecords	Total number of records across all pages. Data type: integer with format int64 For example: 1 Is mandatory: No
totalPages	Total number of pages. Data type: integer with format int64 For example: 1 Is mandatory: No

Person

Persons details.

Property	Value
name	Unstructured / preferred name as text. Data type: string For example: Is mandatory: No
fullName	Structured name for a person. Data type: object using the model PersonName Is mandatory: No
contactDetail	Person contact detail. Data type: object using the model ContactDetail Is mandatory: No
certification	Details of the certifications the representative holds if applicable. Data type: array [object] using the model TradeIdentifier Is mandatory: No

PersonName

Structured name for a person.

Property	Value
title	Title. Data type: string For example: Mr Is mandatory: No
givenName	Given / first name. Data type: string For example: Steven Is mandatory: No
middleNames	Middle names. Data type: string For example: John Is mandatory: No
surname	Surname / last name. Data type: string For example: Smith Is mandatory: No

ReferenceDataResult

Property	Value
code	Code supplied from source Data type: string Is mandatory: No
name	Name Data type: string Is mandatory: No
description	Description Data type: string Is mandatory: No
language	Language, defaults to EN Data type: string Is mandatory: No

ReferenceDataResultPagedResult

Paginated response from the API.

Property	Value
data	Specified page within the data set. Data type: array [object] using the model ReferenceDataResult Is mandatory: No
records	Number of records in the current page. Data type: integer with format int64 For example: 1 Is mandatory: No
pageNumber	Page number. Data type: integer with format int64 For example: 1 Is mandatory: No
pageSize	Page size. Data type: integer with format int64 For example: 10 Is mandatory: No
totalRecords	Total number of records across all pages. Data type: integer with format int64 For example: 1 Is mandatory: No
totalPages	Total number of pages. Data type: integer with format int64 For example: 1 Is mandatory: No

ResourceLink

Hypermedia as the Engine of Application State (HATEOAS) resource link.

Property	Value
href	Uniform Resource Identifier of the resource being linked to. Data type: string Is mandatory: No
rel	Relationship of the resource. Data type: string Is mandatory: No
method	HTTP method to use when calling the resource. Data type: string Is mandatory: No

TradeIdentifier

Property	Value
id	A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects within the same scheme. Data type: string Is mandatory: No
name	A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute. Data type: string Is mandatory: No
schemaId	The identification of the identification scheme. Data type: string Is mandatory: No
schemaName	The name of the identification scheme. Data type: string Is mandatory: No
agencyId	The identification of the agency that maintains the identification scheme. Data type: string Is mandatory: No
agencyName	The name of the agency that maintains the identification scheme. Data type: string Is mandatory: No
versionId	The Version of the identification scheme. Data type: string Is mandatory: No
uniformResourceId	The Uniform Resource Identifier that identifies where the identification scheme data is located. Data type: string Is mandatory: No
schemaUniformResourceId	The Uniform Resource Identifier that identifies where the identification scheme is located. Data type: string Is mandatory: No
language	The identifier of the language used in the corresponding text string. Data type: string For example: EN Is mandatory: No

What3Words

What 3 Words location identifier details.

Property	Value
wordOne	Word one. Data type: string For example: Is mandatory: No
wordTwo	Word two. Data type: string For example: Is mandatory: No
wordThree	Word three. Data type: string For example: Is mandatory: No

Downloads

This API follows the OpenApi specification and is available for export and download in the following formats:

OpenAPI 3 JSON

JSON, 4 KB

This file contains the JSON Format for OpenApi 3.

OpenAPI 3 YAML

YAML, 4 KB

This file contains the YAML Format for OpenApi 3.

Cookies on Defra Trade Developer Portal

Export Health Certificate Reference Data API

API

Operations

Get /border-control-post

Get /certifier

Get /country

Get /measurement-temperature

Get /measurement-weight

Get /metadata

Get /package-type

Get /transport-means

Schemas

Address

BorderControlPost

BorderControlPostPagedResult

CommonProblemDetails

ContactDetail

Coordinates

Country

CountryPagedResult

DatasetMetadata

Measure

MetadataGet200ApplicationJsonResponse

Package

PackagePagedResult

Party

PartyPagedResult

Person

PersonName

ReferenceDataResult

ReferenceDataResultPagedResult

ResourceLink

TradeIdentifier

What3Words

Downloads

OpenAPI 3 JSON

OpenAPI 3 YAML