Shipment Requests

This section describes the concept of shipment requests in YubiEnterprise Delivery services. For instructions on how to work with shipment requests, see Working with Shipments.

You can manage shipments from your inventory of purchased products on the All shipments page. Even if not all your products are being shipped through YubiEnterprise Delivery, you can track shipment requests regardless of how those shipments are processed by Yubico.


Shipments processed through YubiEnterprise Delivery (Console or API) are considered “Automatic”, whereas the shipments created by Yubico or a channel partner at your request are considered “Manual”. The Type column on the All shipments page in the Console displays the type of shipment.

You can create shipment requests from the All shipments page. You can also create shipment requests from subscription cards on the Console dashboard. For more information, see Dashboard.

Console Owners and Admins can request (create) shipments and edit the requests if the shipment is of the Automated type and has not yet been processed. The Status column shows the Shipment Request Status.

Shippable Inventory

On certain occasions, shippable quantities for a product might be allocated, for example due to limited availability. Inventory allocation is also used for shipment of customized keys to indicate the number of pre-programmed keys available for shipment.

If there is an inventory allocation set for a specific product you will see the availability on your Dashboard and in the Create shipment request form when requesting shipments.


If there are no shippable products available, you will not be able to request shipments. The allocation is removed or updated as soon as the affected products become available.

You can enable the Only show shippable inventory toggle switch on the top right of the Dashboard to see products that can be shipped through automated shipments.

If the toggle is turned on, the inventory allocation is displayed only if it has been set for a product that can be shipped using the YubiEnterprise Console (automated shipments). In that case, the remaining product volume supported by automatic shipment is smaller than the actual total remaining available allocated inventory number that can be shipped using manual and automated shipments.

Methods of Requesting Shipments

You can use any of the following methods to create shipment requests:

Address Validation

When Yubico’s address validation service catches a discrepancy between an address in a shipment request and post office standards, the system flags the affected shipment request. Requests with such discrepancies are shown as “Incomplete” in the Status column of the Console. Incompletes must be reviewed and the proposed change accepted or rejected before the request can be processed. For instructions, see Reviewing Incompletes.

Limits and Constraints

Post Office Boxes

Although the system can deliver to Post Office (PO) Boxes within the United States, delivery to the equivalent elsewhere in the world is unlikely to succeed.

Recipient Information

Names and Addresses: First Line

First name and Last name in the Console and in the CSV file for bulk shipments, map to the first line on the shipping label.

Long recipient names can be problematic for all methods of requesting shipment, because the shipment request will fail if the contents of the First name and Last name fields and/or Company or recipient fields exceed the maximum number of characters permitted in these fields (shown in the table below).

Workaround: When a recipient’s full name or company name exceeds the fields’ maximum lengths, split the names across the three fields, as in this example:

Location Field (limit=15) Field (limit=20) Field (limit=20)
API recipient_firstname recipient_lastname recipient
CSV First name Last name Company
Console First name Last name Company
Example of an overly long name before adjustment to fit the fields
  Johannes-Maximilian von Derschowitz-Dampfloch zu Querdenker
Example after adjustment
  Joh.-Maximilian v.DerschowitzDampfloch zu Querdenker

Company Name: Second Line

The second line on the shipping label maps to the name of the recipient’s company if the address is not residential. For example, the system’s address verification function recognizes that Yubico’s Santa Clara facility is in a commercial building, therefore the company name is expected in:

  • The Company field/table cell in the Console and in the CSV file.

  • The recipient field in the API


    API: Do not use the /shipments recipient field to specify the name of the individual to whom products are to be shipped. For this, use the recipient_firstname and recipient_last name fields instead.

If the address is residential, leave empty:

  • The Company field/table cell in the Console and in the CSV file.
  • The recipient field in the API.

Address Information

Incomplete or incorrect address information might cause validation errors. For example, entering the following information for a shipment request would result in failure because USPS recognizes that there are multiple companies in the building whose address is 530 Lytton Avenue:

Jan Lindberg
530 Lytton Avenue
Palo Alto, CA 94301

Similarly, entering the following information for a shipment request would result in failure because a residential address would not be associated with a company.

Jan Lindberg
Yubico Inc.
6 Lea Rd
Dronfield S18 1SB

When adding address information, you can for example use the address formats provided by Google Maps, see note in Troubleshooting. The limits on the various fields and the options for the dropdown are given in Shipment Request Form Fields.

Address Validation
Every 15 minutes, the system validates addresses; therefore you might have to wait up to 15 minutes to find out if your shipment request has been queued for fulfillment. For more information, see Shipping Status Codes.
Availability of Stock/Inventory
Shipment allocations may be set. For more information, see Shippable Inventory.
Non-subscription Purchases
Shipment requests can be made for up to one year after a PO is submitted.
Subscription Purchases
Availability of products depends on the stock/inventory from which the products are drawn. For more information, see Tier Sub-categories.


Shipment Requests
Shipment requests can be edited or deleted until 2am PST (10am GMT), the day after they were entered. For more information, see Editing or Deleting a Shipment.

Normal (standard) shipping: Typically, shipments will take 5-7 days for delivery in North America and Europe. Delivery to other parts of the world will take longer.

Expedited (rush) shipping: Typically, shipments within North America can be delivered in 1 business day. It may take longer to deliver shipments to other parts of the world, but Yubico will leverage the fastest delivery service reasonably available.

Shipment Status Messages

These error messages accessible via the API tell you why a given shipment request was unsuccessful. It is worth reviewing them before making any shipping requests in order to see what sort of issues might arise and thereby avoid them in the first place.

In the Explanation column, the source of the message is given: YubiEnterprise Delivery system for internal messages, US Validation for the US Postal Service, and finally, International Validation. Messages originating from the last two are simply passed on to you by YubiEnterprise Delivery.

YubiEnterprise Delivery API status messages
Message Explanation
InventoryProductId not specified for
ProductId %d - ShipmentStateError
YubiEnterprise Delivery system
Too many keys in shipment -
TotalKeysShipped %d > %d - ShipmentStateError
YubiEnterprise Delivery system
Not enough Inventory for Shipment -
YubiEnterprise Delivery system
Re-enter the address differently; some parts
of it are invalid.
US Validation
The address is invalid.

US Validation
The address is valid.

No further explanation required.
US Validation
Remove the ‘secondary unit designator’
(apt, suite, department, etc.)
because it is superfluous.
Remove the apartment number, unit, etc.:
it is considered wrong or unnecessary.
US Validation
Enter second line information (apartment, unit,
etc.). The information in the primary line is not
specific enough.
Add the apartment number, unit, etc.
US Validation

The address is a valid military address.

No further explanation required.
US Validation
The address is a valid General Delivery address
where individuals without permanent addresses
can receive mail.
No further explanation required.
US Validation

The address is valid. An organization such as a
government agency can have its own zipcode
because it receives a large volume of mail.
No further explanation required.
US Validation

Enter a street number; for example, for Yubico
“Lytton Ave” alone is not sufficient, it needs to
be “530 Lytton Ave”.
The number on the primary line, for example
the “185” in “185 Berry Street” is missing.
US Validation
Enter a valid street number.

The number on the primary line, for example
the “185” in “185 Berry Street” not valid.
US Validation
Enter a PO Box, Rural Route, or Highway
Contract number.
US Validation

Enter a valid PO Box, Rural Route, or Highway
Contract box number.
US Validation

Enter the Private Mailbox (PMB) identifier or the
# sign, followed by the PMB number.
PMB number is Private Mailbox Number
US Validation
This address is not eligible to receive mail.

US Validation

The address is that of a Commercial Mail
Receiving Agency (CMRA) a private business that
accepts mail for recipients, and the required
private mailbox information is present.
US Validation

The address is missing some important
secondary line information
(apartment, unit, etc).
No further explanation required.
International Validation

Mail is unlikely to arrive at this destination
- please verify input.
No further explanation required
International Validation
This street could not be found within the city
or postal code.
No further explanation required
International Validation
Invalid OrganizationId for Shipment

YubiEnterprise Delivery system

Country Code not set for Shipment

YubiEnterprise Delivery system

Country could not be found from
CountryCode2: %s
Country code entered is not in
YubiEnterprise Delivery system list
Shipment has no shipment items

YubiEnterprise Delivery system

DeliveryType not set for Shipment,
defaulting to 1 - normal
YubiEnterprise Delivery system

Invalid DeliveryType %s for Shipment

YubiEnterprise Delivery system

InventoryType not set for Shipment,
defaulting to 1
YubiEnterprise Delivery system

InventoryType %s not valid set for Shipment

You cannot use this InventoryType for this
shipment - YubiEnterprise Delivery system
Negative quantity entered for ShipmentItem
with ProductId=%d defaulting to 0

You set the quantity of the specified
ProductID to be shipped to less than zero.
YubiEnterprise Delivery system
Invalid ShipmentProductQuantity for
ShipmentItem %d
You probably do not have sufficient inventory.
YubiEnterprise Delivery system
Invalid ShipmentProductLineCost for
ShipmentItem %d
YubiEnterprise Delivery system

Invalid Shipment - Total keys in shipment
greater than 500
You cannot ship more than 500 items at once.
YubiEnterprise Delivery system
Shipment has zero total item quantity

The number of items to be shipped must be > 0.
YubiEnterprise Delivery system
US Address is missing the state
name/abbrevation in region field
No further explanation required.
YubiEnterprise Delivery system
Bad ProductId in ShipmentProduct for
ProductID is wrongly specified or invalid.
YubiEnterprise Delivery system
Input for %s exceeded limit of %d characters

Specified field cannot accept the number of
characters that were entered.
YubiEnterprise Delivery system
Shipment of these products to this country
using this delivery type is not supported
For more information, see Delivery Policies.
Shipment request contravenes one or more
business rules.
YubiEnterprise Delivery system

Subscriptions and Inventories

The following provides an overview of different subscription and inventory options. For more information, see Modes of Purchase.

Subscription (2.0)

Subscription (2.0) - full list of inventory (stock) types
Name of Tier

Initial or
Primary or
Console: “Product selection”,
“Products” dropdown
Base Standard tier
(FIDO-only key license(s))
Security Keys only
Initial Primary Base Standard Primary
Backup Base Standard Backup
Replacement Primary
Base Standard
Primary Replacemen
Base Standard
Backup Replacement
Base Plus tier
Initial Primary Base Plus Primary
Backup Base Plus Backup
Replacement Primary
Base Plus
Primary Replacement
Base Plus
Primary Replacement
Advanced Standard tier
(Multiprotocol key license(s))
YubiKey 5 Series including
YubiKey 5 Ci
Initial Primary
Advanced Standard
Advanced Standard
Replacement Primary
Advanced Standard
Primary Replacement
Advanced Standard
Backup Replacement
Advanced Plus tier
Initial Primary Advanced Plus Primary
Backup Advanced Plus Backup
Replacement Primary
Advanced Plus
Primary Replacement
Advanced Plus
Backup Replacement
Compliance Standard tier
(Certified key license(s))

Initial Primary
Compliance Standard
Compliance Standard
Replacement Primary
Compliance Standard
Primary Replacement
Compliance Standard
Backup Replacement
Compliance Plus tier
Initial Primary Compliance Plus Primary
Backup Compliance Plus Backup
Replacement Primary
Compliance Plus
Primary Replacement
Compliance Plus
Backup Replacement

Subscription (1.0)

The full list of options that were potentially available in Subscription (1.0) is given below. The actual list depends on what you have purchased. Explanations for the terms in the list are given in the table below the list. For more details on subscription and non-subscription purchasing, see Modes of Purchase.

Subscription (1.0): Full List of Inventory Types

  • Primary Subscr - Base Tier: Initial
  • Primary Subscr - Base Tier: Buffer
  • Primary Subscr - Base Tier: Replacement
  • Primary Subscr - Adv. Tier: Initial
  • Primary Subscr - Adv. Tier: Buffer
  • Primary Subscr - Adv. Tier: Replacement
  • Primary Subscr - Prem. Tier: Initial
  • Primary Subscr - Prem. Tier: Buffer
  • Primary Subscr - Prem. Tier: Replacement
  • Primary Subscr - FIPS Tier: Initial
  • Primary Subscr - FIPS Tier: Buffer
  • Primary Subscr - FIPS Tier: Replacement
  • Backup Subscr - Base Tier: Initial
  • Backup Subscr - Base Tier: Buffer
  • Backup Subscr - Base Tier: Replacement
  • Backup Subscr - Adv. Tier: Initial
  • Backup Subscr - Adv. Tier: Buffer
  • Backup Subscr - Adv. Tier: Replacement
  • Backup Subscr - Prem. Tier: Initial
  • Backup Subscr - Prem. Tier: Buffer
  • Backup Subscr - Prem. Tier: Replacement
  • Backup Subscr - FIPS Tier: Initial
  • Backup Subscr - FIPS Tier: Buffer
  • Backup Subscr - FIPS Tier: Replacement
  • Non-subscription - Base Tier
  • Non-subscription - Advanced Tier
  • Non-subscription - Premium Tier
  • Non-subscription - FIPS Tier
  • Standard Products
Standard Products Subscription Non-subscription
Standard products are
physical keys purchased
outright (on your PO
you will not find
“Standard Products”,
but instead the actual
products/models that
you purchased).

There is a primary
subscription and a backup
subscription for each
tier (product grouping):
Base, Advanced, Premium,
and FIPS. Each of those
tiers has Initial,
Buffer, and Replacement
sub-categories, explained
in the table below,
The non-subscription
tiers are for virtual
keys. Unlike
subscription tiers,
tiers have no

Tier Sub-categories

Stock: Initial, Buffer, Replacement
The stock in this category reflects the
total number of users on the subscription. This
lot can be drawn upon for 12 months from the
start of your subscription term.
This category is made available to you free of
charge when your subscription begins. You can
draw on it throughout the term of your
This category is intended for those who have
lost their YubiKeys or want to upgrade. The
stock in this category is reset each year of
the subscription to the Replacement limit.

To file a support ticket for YubiEnterprise Delivery, click Support.