Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Register rough

Please note

  • Rough diamonds can only be registered on Tracr by producers and manufacturers. Retailers should use the transfer endpoints to accept polished diamonds from manufacturers on the Tracr network.

  • Rough diamonds registered via the API won't appear in the Integration Monitoring section of the Tracr Portal.

Register a De Beers diamond

To register a diamond from a De Beers sight box, call the /diamonds/rough/create endpoint with the De Beers box ID, along with the sight year and number:

Call POST /diamonds/rough/create

{
    "box_id": "demo_box",
    "participant_id": "demo_1",
    "participant_timestamp": "2024-05-31T11:38:38.206655+00:00",
    "rough": {
        "carats": 2.16
    },
    "sight_no": 2,
    "sight_year": 2024
}
{
    "assurance_level": "assured",
    "box_id": "demo_box",
    "current_stage": "rough",
    "diamond_id": "wemz3zvg7cvr5uugivhib1z0",
    "entity_specific_tags": {},
    "id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6",
    "is_current": true,
    "lifecycle_state": "rough",
    "participant_id": "demo_1",
    "participant_timestamp": "2024-05-31T11:38:38.206655+00:00",
    "polished": {},
    "possession_state": "held",
    "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee",
    "provenance": {
        "provenance_name": "",
        "provenance_type": "Entity",
        "is_locked": true,
        "is_country_code_available": true
    },
    "rough": {
        "carats": 2.16
    },
    "schema_version": "1.1.0",
    "sight_no": 2,
    "sight_year": 2024,
    "system_timestamp": "2024-05-31T11:41:25.525000+00:00",
    "verification_description": "verified record",
    "verification_status": "Verified",
    "version_id": "hyfyv1o484li32aof6af5fbr",
    "verification_status_modified_at": "2024-05-31T11:41:26.068930+00:00"
}

If the registration failed then the reason for the failure will be given in the response, for example:

{
    "message": "Diamond is not unique"
}

Register a diamond from another producer

Non-De Beers diamonds are sent from the producer's Tracr instance as shipments. These will appear in the Inbound Shipments screen of the Tracr Portal when ready.

The shipment needs to be accepted before any of the diamonds can be registered - see Transfer In for how to accept a shipment of rough diamonds.

Important: When uploading diamonds, instead of providing the box details from De Beers (such as sight, year, and box ID), you will need to provide the Shipment ID in the “box_id” column. The Shipment ID appears on the Active tab, next to the Sender.

Once accepted, call the /diamonds/rough/create endpoint, passing the shipment ID assigned by Tracr as the box ID:

Call POST /diamonds/rough/create

Tracr checks the weight and number of diamonds registered against each shipment. If these don't align then an error will be returned:

Register a diamond as a producer

Diamond producers register rough diamonds via the same endpoint, but can specify provenance information when doing so:

Call POST /diamonds/rough/create

An important note regarding provenance

Only a diamond producer can declare the provenance of a diamond. Once a manufacturer registers a rough diamond in Tracr, the provenance is updated by Tracr after verification of the traceability data.

Upload additional assets

Once the diamond has been created, additional assets can be attached.

Tracr can append the following files:

  • Scan

  • Images

  • Videos

For example, to add an image of the rough diamond:

Call POST /diamonds/wemz3zvg7cvr5uugivhib1z0/files/image

Key
Value

file

demo_1_rough.jpeg

description

Rough Image

image_type

default

PreviousSecurityNextSplit

Last updated