Skip to main content
POST
Mint a GIAI from one of the organization's prefixes

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
company_prefix_id
string<shortuuid>
required

Id of the GS1 Company Prefix.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Request body to self-service mint a GIAI from one of the org's prefixes.

Which prefix to mint from is a path parameter (company_prefix_id on the endpoint itself), not a body field — it names the resource being acted on.

asset_reference
string
required

Individual asset reference (CSET-82). Combined with the prefix, at most 30 characters total.

Required string length: 1 - 30
name
string
required

Human-readable name (e.g. 'Forklift #14').

Required string length: 1 - 255
description
string
default:""

Consumer-facing description shown on the hosted page.

asset_category
string
default:""

Free-form category (e.g. 'vehicle', 'IT equipment', 'tool').

Maximum string length: 120
sku
string
default:""

Manufacturer/vendor SKU or model number. Not a GS1 identifier.

Maximum string length: 120
serial_number
string
default:""

Manufacturer's serial number, if known.

Maximum string length: 120
product_url
string
default:""

Manufacturer's page for this item, linked from the hosted page.

Response

OK

The individual asset (GIAI) that resulted from a mint request.

giai
string
required

The minted Global Individual Asset Identifier (AI 8004).

name
string
required

Human-readable name of the asset.

created
boolean
required

True if this call created a new asset; false if it enriched an existing one (idempotent).

is_conformant
boolean
required

Whether this GIAI may be presented as GS1-conformant.

hosted_page_url
string
required

Path to the asset's public hosted page.