Diamonds

Create Rough Diamond

post

/diamonds/rough/create

Create a rough diamond in the inventory.

Body

Describes what's mandatory for the create rough diamond endpoint, regardless of a particular instance's configuration.

assurance_levelstring · enumOptional

Represents the assurance level for a diamond.

Default: assuredPossible values:

box_descriptionstring · nullableOptional

Box description
Tracr class: entity_specific

box_idstringRequired

System name and ID pairs identifying the source batch for the diamond.
Tracr class: entity_specific

participant_idstringRequired

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID. This field must be unique within the box/shipment the diamond is registered against.

Pattern: ^\S(.*\S)?$

participant_timestampstring · date-timeRequired

A timestamp (in ISO8601 format) representing the real world time that the change happened.
Tracr class: entity_specific

sight_noany of · nullableOptional

Sight number
Tracr class: entity_specific

integerOptional

nullOptional

sight_yearany of · nullableOptional

Sight year
Tracr class: entity_specific

integerOptional

nullOptional

Responses

200

Successful Response

application/json

A diamond as returned from V1 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/rough/create

POST /diamonds/rough/create HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 574

{
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "participant_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "rough": {
    "carats": 1,
    "colour": "text",
    "display_colour": "text",
    "fancy_colour": "text",
    "fancy_colour_intensity": "text",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "text",
    "fluorescence_intensity": "text",
    "model": "text",
    "quality": "text",
    "stress": "text"
  },
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Resend Data Request

post

/diamonds/{diamond_id}/data-request/{data_request_id}/resend

Resend a pending diamond data request.

Path parameters

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

data_request_idstringRequired

Responses

201

Successful Response

application/json

anyOptional

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Returned when the specified DiamondDataRequest could not be found.

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Returned when the DiamondDataRequest is not in a pending state, or when it lacks an associated IntegrationEvent.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{diamond_id}/data-request/{data_request_id}/resend

POST /diamonds/{diamond_id}/data-request/{data_request_id}/resend HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

No content

Get Diamond

get

/diamonds/{id}

Returns the current version of the requested diamond, if it exists.

Path parameters

idany ofRequired

The ID (UUID or Diamond ID) of the diamond

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Query parameters

only_if_heldbooleanOptional

If true, the diamond is returned only if its possession state is HELD

Default: false

Responses

200

Successful Response

application/json

A diamond as returned from V1 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity, request does not match specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

get/diamonds/{id}

GET /diamonds/{id} HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Upload Diamond Grading Certificate

post

/diamonds/{id}/files/grading_certificates

Upload any grading report associating it with the polished diamond. Rough diamonds cannot be updated with a grading report file.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

The form usede by the upload_grading_certificate_endpoint.

caratsany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

certificate_filestring · binary · nullableOptional

The grading certificate file.

claritystring · enum · nullableOptionalPossible values:

clarity_characteristics_diagramstring · binary · nullableOptional

colourstring · enum · nullableOptionalPossible values:

crown_angleany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

crown_heightany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

culet_conditionstring · enum · nullableOptionalPossible values:

culet_sizestring · enum · nullableOptionalPossible values:

cut_gradestring · enum · nullableOptionalPossible values:

depthany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

depth_percentany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

diameter_maximumany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

diameter_minimumany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

fancy_colourstring · enum · nullableOptionalPossible values:

fancy_colour_intensitystring · enum · nullableOptionalPossible values:

fancy_colour_overtonestring · nullableOptional

filestring · binary · nullableOptionalDeprecated

The grading certificate file. This field is deprecated, use certificate_file instead.

fluorescence_colourstring · enum · nullableOptionalPossible values:

fluorescence_intensitystring · enum · nullableOptionalPossible values:

girdle_conditionstring · enum · nullableOptionalPossible values:

girdle_thickness_fromstring · enum · nullableOptionalPossible values:

girdle_thickness_tostring · enum · nullableOptionalPossible values:

graded_datestring · nullableOptional

grader_certificate_nostring · nullableOptional

grader_clarity_characteristicsstring · nullableOptional

grader_inscription_nostring · nullableOptional

grader_report_nostring · nullableOptional

grading_certificate_descriptionstring · nullableOptional

grading_labstring · nullableOptionalDefault: Other

lengthany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

measurement_textstring · nullableOptional

pavillion_angleany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

pavillion_percentany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

polish_qualitystring · enum · nullableOptionalPossible values:

proportions_diagramstring · binary · nullableOptional

shapestring · enum · nullableOptional

An enum of the possible values for the shape of a diamond.

Possible values:

symmetrystring · enum · nullableOptionalPossible values:

table_percentany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

validation_levelstring · enum · nullableOptionalPossible values:

widthany of · nullableOptional

numberOptional

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Responses

200

Successful Response

application/json

graded_measurement_idstringRequired

Graded Measurement ID.

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/grading_certificates

POST /diamonds/{id}/files/grading_certificates HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 947

{
  "carats": 1,
  "certificate_file": "binary",
  "clarity": "FL",
  "clarity_characteristics_diagram": "binary",
  "colour": "D",
  "crown_angle": 1,
  "crown_height": 1,
  "culet_condition": "P",
  "culet_size": "EL",
  "cut_grade": "I",
  "depth": 1,
  "depth_percent": 1,
  "diameter_maximum": 1,
  "diameter_minimum": 1,
  "fancy_colour": "BK",
  "fancy_colour_intensity": "F",
  "fancy_colour_overtone": "text",
  "fluorescence_colour": "B",
  "fluorescence_intensity": "VS",
  "girdle_condition": "P",
  "girdle_thickness_from": "Extremely Thick",
  "girdle_thickness_to": "Extremely Thick",
  "graded_date": "text",
  "grader_certificate_no": "text",
  "grader_clarity_characteristics": "text",
  "grader_inscription_no": "text",
  "grader_report_no": "text",
  "grading_certificate_description": "text",
  "grading_lab": "Other",
  "length": 1,
  "measurement_text": "text",
  "pavillion_angle": 1,
  "pavillion_percent": 1,
  "polish_quality": "I",
  "proportions_diagram": "binary",
  "shape": "Asscher",
  "symmetry": "I",
  "table_percent": 1,
  "validation_level": "validation",
  "width": 1
}

{
  "graded_measurement_id": "text",
  "hash": "text"
}

Upload Diamond Image

post

/diamonds/{id}/files/images

Upload an image file associating it with the current lifecycle state of the diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

image_typestring · enumOptional

Valid values: default, 3d, b2b, heart, arrow, aset_scope, plot, face_up, dark_field, ideal_scope, fluorescence, inclusion_map, diagram, other. Default: default

Default: defaultPossible values:

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/images

POST /diamonds/{id}/files/images HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 61

{
  "description": "text",
  "file": "binary",
  "image_type": "default"
}

{
  "hash": "text"
}

Upload Diamond Plan

post

/diamonds/{id}/files/plan

Upload a plan file associating it with only the rough diamond. Polished diamonds cannot be updated with a plan file.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

plan_software_manufacturerstring · nullableOptional

plan_software_namestring · nullableOptional

plan_software_versionstring · nullableOptional

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/plan

POST /diamonds/{id}/files/plan HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 133

{
  "description": "text",
  "file": "binary",
  "plan_software_manufacturer": "text",
  "plan_software_name": "text",
  "plan_software_version": "text"
}

{
  "hash": "text"
}

Upload Diamond Plan Report

post

/diamonds/{id}/files/plan/reports

Upload a plan file report associating it with only the rough diamond. Polished diamonds cannot be updated with a plan file.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

plan_software_manufacturerstring · nullableOptional

plan_software_namestring · nullableOptional

plan_software_versionstring · nullableOptional

scan_device_manufacturerstring · nullableOptional

scan_device_modelstring · nullableOptional

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/plan/reports

POST /diamonds/{id}/files/plan/reports HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 194

{
  "description": "text",
  "file": "binary",
  "plan_software_manufacturer": "text",
  "plan_software_name": "text",
  "plan_software_version": "text",
  "scan_device_manufacturer": "text",
  "scan_device_model": "text"
}

{
  "hash": "text"
}

Upload Diamond Scan

post

/diamonds/{id}/files/scan

Upload a scan file associating it with the current lifecycle state of the diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

scan_device_manufacturerstring · nullableOptional

scan_device_modelstring · nullableOptional

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/scan

POST /diamonds/{id}/files/scan HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 99

{
  "description": "text",
  "file": "binary",
  "scan_device_manufacturer": "text",
  "scan_device_model": "text"
}

{
  "hash": "text"
}

Upload Diamond Scan Report

post

/diamonds/{id}/files/scan/reports

Upload a scan report file associating it with the current lifecycle state of the diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

scan_device_manufacturerstring · nullableOptional

scan_device_modelstring · nullableOptional

scan_software_namestring · nullableOptional

scan_software_versionstring · nullableOptional

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/scan/reports

POST /diamonds/{id}/files/scan/reports HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 158

{
  "description": "text",
  "file": "binary",
  "scan_device_manufacturer": "text",
  "scan_device_model": "text",
  "scan_software_name": "text",
  "scan_software_version": "text"
}

{
  "hash": "text"
}

Upload Diamond Supplementary File

post

/diamonds/{id}/files/supplementary_files

Upload any supplementary files associating them with the current lifecycle state of the diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/supplementary_files

POST /diamonds/{id}/files/supplementary_files HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38

{
  "description": "text",
  "file": "binary"
}

{
  "hash": "text"
}

Upload Diamond Video

post

/diamonds/{id}/files/videos

Upload a video file associating it with the current lifecycle state of the diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

descriptionstring · nullableOptional

filestring · binaryRequired

Responses

200

Successful Response

application/json

hashstringRequired

File contents hash.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity. Incorrect file extension.

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/files/videos

POST /diamonds/{id}/files/videos HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38

{
  "description": "text",
  "file": "binary"
}

{
  "hash": "text"
}

Get Diamond File

get

/diamonds/{id}/files/{hash}

Download a file

Path parameters

hashstringRequired

File contents hash.

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Responses

302

A redirection to a presigned S3 url for the requested file.

application/json

anyOptional

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

get/diamonds/{id}/files/{hash}

GET /diamonds/{id}/files/{hash} HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

No content

Get Graded Measurements

get

/diamonds/{id}/graded-measurements

Get an unpaginated list of all graded measurements for the diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Responses

200

Successful Response

application/json

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

get/diamonds/{id}/graded-measurements

GET /diamonds/{id}/graded-measurements HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "results": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ]
}

Deselect Graded Measurement

patch

/diamonds/{id}/graded-measurements/{graded_measurement_id}/deselect

Mark the specified graded measurement as inactive.

Path parameters

graded_measurement_idstringRequired

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Responses

200

Successful Response

application/json

Represents a single GradedMeasurement row for a diamond.

caratsstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

claritystring · enum · nullableOptionalPossible values:

colourstring · enum · nullableOptionalPossible values:

crown_anglestring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

crown_heightstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

culet_conditionstring · enum · nullableOptionalPossible values:

culet_sizestring · enum · nullableOptionalPossible values:

cut_gradestring · enum · nullableOptionalPossible values:

depthstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

depth_percentstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

diameter_maximumstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

diameter_minimumstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

display_colourstring · nullableOptional

fancy_colourstring · enum · nullableOptionalPossible values:

fancy_colour_intensitystring · enum · nullableOptionalPossible values:

fancy_colour_overtonestring · nullableOptional

fluorescence_colourstring · enum · nullableOptionalPossible values:

fluorescence_intensitystring · enum · nullableOptionalPossible values:

girdle_conditionstring · enum · nullableOptionalPossible values:

girdle_thickness_fromstring · enum · nullableOptionalPossible values:

girdle_thickness_tostring · enum · nullableOptionalPossible values:

graded_datestring · date-time · nullableOptional

grader_certificate_numberstring · nullableOptional

grader_clarity_characteristicsstring · nullableOptional

grader_colourstring · nullableOptional

grader_inscription_numbersstring[] · nullableOptional

grader_report_commentsstring · nullableOptional

grader_report_numberstring · nullableOptional

grader_report_typestring · nullableOptional

grader_shapestring · nullableOptional

grading_certificate_descriptionstring · nullableOptional

grading_certificate_filenamestring · nullableOptional

grading_certificate_hashstring · nullableOptional

grading_labstring · enum · nullableOptional

An Enum of grading lab values to be used when interacting with PCS-API.

Possible values:

idstringRequired

is_activebooleanRequired

is_selectablebooleanRequired

lengthstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

measurement_textstring · nullableOptional

pavillion_anglestring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

pavillion_percentstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

polish_qualitystring · enum · nullableOptionalPossible values:

shapestring · enum · nullableOptional

An enum of the possible values for the shape of a diamond.

Possible values:

sourcestring · enumRequired

The source of graded measurement data.

Possible values:

symmetrystring · enum · nullableOptionalPossible values:

table_percentstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

validation_levelstring · enum · nullableOptionalPossible values:

widthstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

patch/diamonds/{id}/graded-measurements/{graded_measurement_id}/deselect

PATCH /diamonds/{id}/graded-measurements/{graded_measurement_id}/deselect HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "carats": "text",
  "clarity": "FL",
  "colour": "D",
  "crown_angle": "text",
  "crown_height": "text",
  "culet_condition": "P",
  "culet_size": "EL",
  "cut_grade": "I",
  "depth": "text",
  "depth_percent": "text",
  "diameter_maximum": "text",
  "diameter_minimum": "text",
  "display_colour": "text",
  "fancy_colour": "BK",
  "fancy_colour_intensity": "F",
  "fancy_colour_overtone": "text",
  "fluorescence_colour": "B",
  "fluorescence_intensity": "VS",
  "girdle_condition": "P",
  "girdle_thickness_from": "Extremely Thick",
  "girdle_thickness_to": "Extremely Thick",
  "graded_date": "2026-08-08T00:31:58.007Z",
  "grader_certificate_number": "text",
  "grader_clarity_characteristics": "text",
  "grader_colour": "text",
  "grader_inscription_numbers": [
    "text"
  ],
  "grader_report_comments": "text",
  "grader_report_number": "text",
  "grader_report_type": "text",
  "grader_shape": "text",
  "grading_certificate_description": "text",
  "grading_certificate_filename": "text",
  "grading_certificate_hash": "text",
  "grading_lab": "AGS",
  "id": "text",
  "is_active": true,
  "is_selectable": true,
  "length": "text",
  "measurement_text": "text",
  "pavillion_angle": "text",
  "pavillion_percent": "text",
  "polish_quality": "I",
  "shape": "Asscher",
  "source": "gis",
  "supplementary_files": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "symmetry": "I",
  "table_percent": "text",
  "validation_level": "validation",
  "width": "text"
}

Select Graded Measurement

patch

/diamonds/{id}/graded-measurements/{graded_measurement_id}/select

Mark the specified graded measurement as active.

Path parameters

graded_measurement_idstringRequired

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Responses

200

Successful Response

application/json

Represents a single GradedMeasurement row for a diamond.

caratsstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

claritystring · enum · nullableOptionalPossible values:

colourstring · enum · nullableOptionalPossible values:

crown_anglestring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

crown_heightstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

culet_conditionstring · enum · nullableOptionalPossible values:

culet_sizestring · enum · nullableOptionalPossible values:

cut_gradestring · enum · nullableOptionalPossible values:

depthstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

depth_percentstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

diameter_maximumstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

diameter_minimumstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

display_colourstring · nullableOptional

fancy_colourstring · enum · nullableOptionalPossible values:

fancy_colour_intensitystring · enum · nullableOptionalPossible values:

fancy_colour_overtonestring · nullableOptional

fluorescence_colourstring · enum · nullableOptionalPossible values:

fluorescence_intensitystring · enum · nullableOptionalPossible values:

girdle_conditionstring · enum · nullableOptionalPossible values:

girdle_thickness_fromstring · enum · nullableOptionalPossible values:

girdle_thickness_tostring · enum · nullableOptionalPossible values:

graded_datestring · date-time · nullableOptional

grader_certificate_numberstring · nullableOptional

grader_clarity_characteristicsstring · nullableOptional

grader_colourstring · nullableOptional

grader_inscription_numbersstring[] · nullableOptional

grader_report_commentsstring · nullableOptional

grader_report_numberstring · nullableOptional

grader_report_typestring · nullableOptional

grader_shapestring · nullableOptional

grading_certificate_descriptionstring · nullableOptional

grading_certificate_filenamestring · nullableOptional

grading_certificate_hashstring · nullableOptional

grading_labstring · enum · nullableOptional

An Enum of grading lab values to be used when interacting with PCS-API.

Possible values:

idstringRequired

is_activebooleanRequired

is_selectablebooleanRequired

lengthstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

measurement_textstring · nullableOptional

pavillion_anglestring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

pavillion_percentstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

polish_qualitystring · enum · nullableOptionalPossible values:

shapestring · enum · nullableOptional

An enum of the possible values for the shape of a diamond.

Possible values:

sourcestring · enumRequired

The source of graded measurement data.

Possible values:

symmetrystring · enum · nullableOptionalPossible values:

table_percentstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

validation_levelstring · enum · nullableOptionalPossible values:

widthstring · nullableOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

patch/diamonds/{id}/graded-measurements/{graded_measurement_id}/select

PATCH /diamonds/{id}/graded-measurements/{graded_measurement_id}/select HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "carats": "text",
  "clarity": "FL",
  "colour": "D",
  "crown_angle": "text",
  "crown_height": "text",
  "culet_condition": "P",
  "culet_size": "EL",
  "cut_grade": "I",
  "depth": "text",
  "depth_percent": "text",
  "diameter_maximum": "text",
  "diameter_minimum": "text",
  "display_colour": "text",
  "fancy_colour": "BK",
  "fancy_colour_intensity": "F",
  "fancy_colour_overtone": "text",
  "fluorescence_colour": "B",
  "fluorescence_intensity": "VS",
  "girdle_condition": "P",
  "girdle_thickness_from": "Extremely Thick",
  "girdle_thickness_to": "Extremely Thick",
  "graded_date": "2026-08-08T00:31:58.007Z",
  "grader_certificate_number": "text",
  "grader_clarity_characteristics": "text",
  "grader_colour": "text",
  "grader_inscription_numbers": [
    "text"
  ],
  "grader_report_comments": "text",
  "grader_report_number": "text",
  "grader_report_type": "text",
  "grader_shape": "text",
  "grading_certificate_description": "text",
  "grading_certificate_filename": "text",
  "grading_certificate_hash": "text",
  "grading_lab": "AGS",
  "id": "text",
  "is_active": true,
  "is_selectable": true,
  "length": "text",
  "measurement_text": "text",
  "pavillion_angle": "text",
  "pavillion_percent": "text",
  "polish_quality": "I",
  "shape": "Asscher",
  "source": "gis",
  "supplementary_files": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "symmetry": "I",
  "table_percent": "text",
  "validation_level": "validation",
  "width": "text"
}

Polish Diamond

post

/diamonds/{id}/polish

Transform a rough diamond to a polished diamond in the inventory.

Path parameters

idany ofRequired

The ID (UUID) of the diamond to polish.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr class: entity_specific

participant_timestampstring · date-time · nullableOptional

A timestamp (in ISO8601 format) representing the real world time that the change happened.
Tracr class: entity_specific

Responses

200

Successful Response

application/json

A diamond as returned from V1 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/polish

POST /diamonds/{id}/polish HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 819

{
  "entity_specific_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "participant_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": 1,
    "clarity": "text",
    "colour": "text",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "text",
    "culet_size": "text",
    "cut_grade": "text",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "text",
    "fancy_colour_intensity": "text",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "text",
    "fluorescence_intensity": "text",
    "girdle_condition": "text",
    "girdle_thickness_from": "text",
    "girdle_thickness_to": "text",
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "text",
    "shape": "Asscher",
    "symmetry": "text",
    "table_percent": 1,
    "width": 1
  },
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Create Rough Child Diamond

post

/diamonds/{id}/rough/create

Following a split, registers any subsequent parts (children) by linking to the original diamond.

Path parameters

idany ofRequired

The ID (UUID) of the diamond to create a child diamond from.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

Describes what's mandatory for the create rough child diamond endpoint, regardless of a particular instance's configuration.

participant_idstringRequired

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr class: entity_specific

Pattern: ^\S(.*\S)?$

participant_timestampstring · date-timeRequired

A timestamp (in ISO8601 format) representing the real world time that the change happened.
Tracr class: entity_specific

Responses

200

Successful Response

application/json

A diamond as returned from V1 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/rough/create

POST /diamonds/{id}/rough/create HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "entity_specific_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "participant_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "rough": {
    "carats": 1,
    "colour": "text",
    "display_colour": "text",
    "fancy_colour": "text",
    "fancy_colour_intensity": "text",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "text",
    "fluorescence_intensity": "text",
    "model": "text",
    "quality": "text",
    "stress": "text"
  },
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Split Diamond

post

/diamonds/{id}/split

Mark a rough diamond as split. Split means the rough diamond has been cut and it is now removed from the inventory.

Path parameters

idany ofRequired

The ID (UUID) of the diamond to split.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

participant_timestampstring · date-timeRequired

The ISO 8601 timestamp of when the real world event occurred

Responses

200

Successful Response

application/json

A diamond as returned from V1 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/diamonds/{id}/split

POST /diamonds/{id}/split HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "participant_timestamp": "2026-08-08T00:31:58.007Z"
}

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Get Diamonds

get

/v2/diamond/

Returns a paginated list of diamonds from the platform.

Query parameters

box_idstringOptional

Filter to diamonds with an exact match on the given box ID.

box_id__containsstringOptional

Filter to diamonds where the box ID contains the given value (case sensitive).

box_id__icontainsstringOptional

Filter to diamonds where the box ID contains the given value (case insensitive).

sight_yearintegerOptional

Filter to diamonds with an exact match on the given sight year.

sight_nointegerOptional

Filter to diamonds with an exact match on the given sight number.

system_timestamp__gtestring · date-timeOptional

Filter to diamonds updated on or after the timestamp. Must be an ISO-8601 compliant timestamp.

system_timestamp__ltstring · date-timeOptional

Filter to diamonds updated before the timestamp. Must be an ISO-8601 compliant timestamp.

participant_timestamp__gtestring · date-timeOptional

Filter to diamonds updated on or after the user supplied timestamp. Must be an ISO-8601 compliant timestamp.

participant_timestamp__ltstring · date-timeOptional

Filter to diamonds updated before the user supplied timestamp. Must be an ISO-8601 compliant timestamp.

diamond_id__instringOptional

Filter to diamonds with one of the specified Tracr IDs.

participant_idstringOptional

Filter to diamonds with the specified participant ID (from ERP).

participant_id__instringOptional

Filter to diamonds with one of the specified participant IDs (from ERP).

diamond_parent_idstringOptional

Filter to diamonds where the parent diamond has the given Tracr ID.

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_id__instringOptional

Filter to diamonds where the parent diamond has one of the given Tracr IDs.

diamond_parent_id__isnullbooleanOptional

Filter diamonds based on whether they have a parent or not.

participant_parent_idstringOptional

Filter to diamonds where the parent diamond has the given participant ID.

participant_parent_id__instringOptional

Filter to diamonds where the parent diamond has one of the given participant IDs.

lifecycle_statestring · enumOptional

Filter to diamonds with the specified lifecycle state.

Possible values:

lifecycle_state__instringOptional

Filter to diamonds with one of the specified lifecycle states.

possession_statestring · enumOptional

Filter to diamonds with the specified possession state.

Possible values:

possession_state__instringOptional

Filter to diamonds with one of the specified possession states.

unlock_statusstring · enumOptional

Filter to diamonds with the specified unlock status.

Possible values:

rough_checkbooleanOptional

Filter to diamonds with or without a rough check.

grading__sourcestring · enumOptional

Filter diamonds with an exact match on the source of the active grading data.

Possible values:

grading__labstring · enumOptional

Filter diamonds with an exact match on the grading lab of the active grading data.

Possible values:

rough_objective_verification_results__isnullbooleanOptional

Filter diamonds based on whether objective verification has been attempted or not.

rough_objective_verification_results__source__instringOptional

Filter diamonds based on the source of the current objective verification.

rough_objective_verification_results__status__instringOptional

Filter diamonds based on the status of the current objective verification.

polished_objective_verification_results__isnullbooleanOptional

Filter diamonds based on whether objective verification has been attempted or not.

polished_objective_verification_results__source__instringOptional

Filter diamonds based on the source of the current objective verification.

polished_objective_verification_results__status__instringOptional

Filter diamonds based on the status of the current objective verification.

grading__report_numberstringOptional

Filter to diamonds where the grader report number matches the given value.

grading__inscription_numberstringOptional

Filter to diamonds where the grader inscription numbers contain the given value.

registered_bystring · enumOptionalDeprecated

Filter to diamonds with the specified registering party (e.g., participant, sarine, diadna). This filter is deprecated and will be removed in a future version. Please use registered_by_integration instead.

Possible values:

registered_by__instringOptionalDeprecated

Filter to diamonds with one of the specified registering parties. This filter is deprecated and will be removed in a future version. Please use registered_by_integration__in instead.

registered_by_integrationstring · enumOptional

Filter to diamonds registered via the specified integration (e.g., participant, sarine).

Possible values:

registered_by_integration__instringOptional

Filter to diamonds registered via one of the specified integrations.

polished_by_integrationstring · enumOptional

Filter to diamonds polished via the specified integration (e.g., participant, sarine).

Possible values:

polished_by_integration__instringOptional

Filter to diamonds polished via one of the specified integrations.

is_archivedbooleanOptional

List archived diamonds

Default: false

outbound_shipment_idstringOptional

Filter to diamonds that appear in the outbound shipment with the specified ID.

in_outbound_shipmentbooleanOptional

Filter diamonds based on whether they're in an active outbound shipment.

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 1000OptionalDefault: 100

Responses

200

Successful Response

application/json

A paginated response containing zero or more diamonds.

nextstring · nullableOptional

The URL for the next page.

pageinteger · min: 1 · nullableRequired

The number of the current page.

pagesinteger · nullableOptional

The total number of pages.

previousstring · nullableOptional

The URL of the previous page.

totalintegerRequired

The total number of results across all pages.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

get/v2/diamond/

GET /v2/diamond/ HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "next": "text",
  "page": 1,
  "pages": 1,
  "previous": "text",
  "results": [
    {
      "archived_at": "2026-08-08T00:31:58.007Z",
      "assets": [
        {
          "asset_type": "image",
          "content_hash": "text",
          "created_at": "2026-08-08T00:31:58.007Z",
          "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
          "diamond_stage": "polished",
          "extension": "bmp",
          "filename": "text",
          "gallery": "rough",
          "gallery_priority": 0,
          "id": "e1mv3nn4n10kd1lw6mde6sums",
          "image_type": "default",
          "is_hero": false,
          "label": "text",
          "updated_at": "2026-08-08T00:31:58.007Z"
        }
      ],
      "assurance_level": "assured",
      "box_description": "text",
      "box_id": "text",
      "current_stage": "polished",
      "data_requests": [
        {
          "created_at": "2026-08-08T00:31:58.007Z",
          "data_request_type": "three_d_plan",
          "errors": [
            "text"
          ],
          "id": "text",
          "status": "pending",
          "updated_at": "2026-08-08T00:31:58.007Z"
        }
      ],
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
      "entity_specific_tags": {
        "dit_session_id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "grading": [
        {
          "carats": "text",
          "clarity": "FL",
          "colour": "D",
          "crown_angle": "text",
          "crown_height": "text",
          "culet_condition": "P",
          "culet_size": "EL",
          "cut_grade": "I",
          "depth": "text",
          "depth_percent": "text",
          "diameter_maximum": "text",
          "diameter_minimum": "text",
          "display_colour": "text",
          "fancy_colour": "BK",
          "fancy_colour_intensity": "F",
          "fancy_colour_overtone": "text",
          "fluorescence_colour": "B",
          "fluorescence_intensity": "VS",
          "girdle_condition": "P",
          "girdle_thickness_from": "Extremely Thick",
          "girdle_thickness_to": "Extremely Thick",
          "graded_date": "2026-08-08T00:31:58.007Z",
          "grader_certificate_number": "text",
          "grader_clarity_characteristics": "text",
          "grader_colour": "text",
          "grader_inscription_numbers": [
            "text"
          ],
          "grader_report_comments": "text",
          "grader_report_number": "text",
          "grader_report_type": "text",
          "grader_shape": "text",
          "grading_certificate_description": "text",
          "grading_certificate_filename": "text",
          "grading_certificate_hash": "text",
          "grading_lab": "AGS",
          "id": "text",
          "is_active": true,
          "is_selectable": true,
          "length": "text",
          "measurement_text": "text",
          "pavillion_angle": "text",
          "pavillion_percent": "text",
          "polish_quality": "I",
          "shape": "Asscher",
          "source": "gis",
          "supplementary_files": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "symmetry": "I",
          "table_percent": "text",
          "validation_level": "validation",
          "width": "text"
        }
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "is_current": true,
      "lifecycle_state": "destroyed",
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "participant_id": "text",
      "participant_parent_id": "text",
      "participant_timestamp": "2026-08-08T00:31:58.007Z",
      "polished": {
        "carats": "text",
        "clarity": "FL",
        "colour": "D",
        "crown_angle": 1,
        "crown_height": 1,
        "culet_condition": "P",
        "culet_size": "EL",
        "cut_grade": "I",
        "depth": 1,
        "depth_percent": 1,
        "diameter_maximum": 1,
        "diameter_minimum": 1,
        "display_colour": "text",
        "fancy_colour": "BK",
        "fancy_colour_intensity": "F",
        "fancy_colour_overtone": "text",
        "fluorescence_colour": "B",
        "fluorescence_intensity": "VS",
        "girdle_condition": "P",
        "girdle_thickness_from": "Extremely Thick",
        "girdle_thickness_to": "Extremely Thick",
        "grading_certificates": [
          {
            "description": "text",
            "filename": "text",
            "graded_date": "text",
            "grader_certificate_no": "text",
            "grader_inscription_no": "text",
            "grader_report_no": "text",
            "grading_lab": "text",
            "hash": "text"
          }
        ],
        "images": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text",
            "image_type": "default"
          }
        ],
        "length": 1,
        "pavillion_angle": 1,
        "pavillion_percent": 1,
        "polish_quality": "I",
        "scan": {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "scan_device_manufacturer": "text",
          "scan_device_model": "text",
          "scan_software_name": "text",
          "scan_software_version": "text"
        },
        "scan_reports": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text",
            "scan_device_manufacturer": "text",
            "scan_device_model": "text",
            "scan_software_name": "text",
            "scan_software_version": "text"
          }
        ],
        "shape": "Asscher",
        "supplementary_files": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text"
          }
        ],
        "symmetry": "I",
        "table_percent": 1,
        "videos": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text"
          }
        ],
        "width": 1
      },
      "polished_objective_verification_results": [
        {
          "id": "text",
          "source": "diadna",
          "status": "in_progress"
        }
      ],
      "possession_state": "destroyed",
      "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "provenance": {
        "country_code": "text",
        "is_country_code_available": true,
        "is_locked": false,
        "mine_name": "text",
        "provenance_name": "text",
        "provenance_type": "text"
      },
      "rough": {
        "carats": "text",
        "colour": "D",
        "display_colour": "text",
        "fancy_colour": "BK",
        "fancy_colour_intensity": "F",
        "fancy_colour_overtone": "text",
        "fluorescence_colour": "B",
        "fluorescence_intensity": "VS",
        "images": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text",
            "image_type": "default"
          }
        ],
        "model": "text",
        "plan": {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "plan_software_manufacturer": "text",
          "plan_software_name": "text",
          "plan_software_version": "text",
          "scan_device_manufacturer": "text",
          "scan_device_model": "text"
        },
        "plan_reports": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text",
            "plan_software_manufacturer": "text",
            "plan_software_name": "text",
            "plan_software_version": "text",
            "scan_device_manufacturer": "text",
            "scan_device_model": "text"
          }
        ],
        "quality": "text",
        "scan": {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "scan_device_manufacturer": "text",
          "scan_device_model": "text",
          "scan_software_name": "text",
          "scan_software_version": "text"
        },
        "scan_reports": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text",
            "scan_device_manufacturer": "text",
            "scan_device_model": "text",
            "scan_software_name": "text",
            "scan_software_version": "text"
          }
        ],
        "stress": "text",
        "supplementary_files": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text"
          }
        ],
        "videos": [
          {
            "description": "text",
            "filename": "text",
            "hash": "text"
          }
        ]
      },
      "rough_check": true,
      "rough_objective_verification_results": [
        {
          "id": "text",
          "source": "diadna",
          "status": "in_progress"
        }
      ],
      "schema_version": "text",
      "sight_no": 1,
      "sight_year": 1,
      "supplementary_tags": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "system_timestamp": "2026-08-08T00:31:58.007Z",
      "three_d_plan_available": false,
      "unlock_status": "locked",
      "verification_description": "verified record",
      "verification_status": "Verified",
      "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
      "version_id": "text"
    }
  ],
  "total": 1
}

Get diamond filters

get

/v2/diamond/filter

Return the filter values that can be used to filter diamonds. This returns three types of value:

Distinct lists contain all distinct values used in the filtered diamonds.
Range lists the min and max values used in the filtered diamonds.
Bucket lists the min and max values and a list of buckets in which diamonds can be found.

Query parameters

lifecycle_statestring · enumOptional

Filter to diamonds with the specified lifecycle state.

Possible values:

possession_statestring · enumOptional

Filter to diamonds with the specified possession state.

Possible values:

grading__is_activebooleanOptional

Filter diamonds with or without an active graded measurement.

is_archivedbooleanOptional

List archived diamonds

Default: false

diamond_parent_id__isnullbooleanOptional

Filter on whether the diamond has no parent

fieldsstring[]Optional

The filter fields to return. If absent, all fields will be returned.

Default: []

Responses

200

Successful Response

application/json

Result filter values found across all diamonds.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

get/v2/diamond/filter

GET /v2/diamond/filter HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "results": {
    "box_id": {
      "distinct": [
        "1",
        "12",
        "123"
      ]
    },
    "diamond_id_check__rough_check": {
      "distinct": [
        false,
        true
      ]
    },
    "sight_no": {
      "distinct": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
      ]
    },
    "sight_year": {
      "distinct": [
        2021,
        2022,
        2023,
        2024
      ]
    }
  }
}

Get Diamond Detail

get

/v2/diamond/{id}

Returns detailed information about a specific diamond, including its top rough (parent diamond) if it exists.

Path parameters

idany ofRequired

The ID (UUID) of the diamond.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Responses

200

Successful Response

application/json

Extended diamond details as returned from the V2 diamond detail endpoint.

This model extends DiamondV2 with additional fields:

top_rough: Details of the diamond's parent rough diamond (if it exists)
status: The possession state of the diamond (same as used in inventory)

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

statusstring · enumRequired

The inventory status of the diamond

Possible values:

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

get/v2/diamond/{id}

GET /v2/diamond/{id} HTTP/1.1
Host: api.<id>.tracr.network
Accept: */*

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assets": [
    {
      "asset_type": "image",
      "content_hash": "text",
      "created_at": "2026-08-08T00:31:58.007Z",
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "diamond_stage": "polished",
      "extension": "bmp",
      "filename": "text",
      "gallery": "rough",
      "gallery_priority": 0,
      "id": "e1mv3nn4n10kd1lw6mde6sums",
      "image_type": "default",
      "is_hero": false,
      "label": "text",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "status": "transferring",
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "top_rough": {
    "assets": [
      {
        "asset_type": "image",
        "content_hash": "text",
        "created_at": "2026-08-08T00:31:58.007Z",
        "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
        "diamond_stage": "polished",
        "extension": "bmp",
        "filename": "text",
        "gallery": "rough",
        "gallery_priority": 0,
        "id": "e1mv3nn4n10kd1lw6mde6sums",
        "image_type": "default",
        "is_hero": false,
        "label": "text",
        "updated_at": "2026-08-08T00:31:58.007Z"
      }
    ],
    "box_description": "text",
    "box_id": "text",
    "current_stage": "polished",
    "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
    "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
    "entity_specific_tags": {
      "dit_session_id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "lifecycle_state": "destroyed",
    "participant_id": "text",
    "participant_timestamp": "2026-08-08T00:31:58.007Z",
    "polished": {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": 1,
      "crown_height": 1,
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": 1,
      "depth_percent": 1,
      "diameter_maximum": 1,
      "diameter_minimum": 1,
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "grading_certificates": [
        {
          "description": "text",
          "filename": "text",
          "graded_date": "text",
          "grader_certificate_no": "text",
          "grader_inscription_no": "text",
          "grader_report_no": "text",
          "grading_lab": "text",
          "hash": "text"
        }
      ],
      "images": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "image_type": "default"
        }
      ],
      "length": 1,
      "pavillion_angle": 1,
      "pavillion_percent": 1,
      "polish_quality": "I",
      "scan": {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      },
      "scan_reports": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "scan_device_manufacturer": "text",
          "scan_device_model": "text",
          "scan_software_name": "text",
          "scan_software_version": "text"
        }
      ],
      "shape": "Asscher",
      "supplementary_files": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text"
        }
      ],
      "symmetry": "I",
      "table_percent": 1,
      "videos": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text"
        }
      ],
      "width": 1
    },
    "possession_state": "destroyed",
    "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "provenance": {
      "country_code": "text",
      "is_country_code_available": true,
      "is_locked": false,
      "mine_name": "text",
      "provenance_name": "text",
      "provenance_type": "text"
    },
    "rough": {
      "carats": "text",
      "colour": "D",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "images": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "image_type": "default"
        }
      ],
      "model": "text",
      "plan": {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      },
      "plan_reports": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "plan_software_manufacturer": "text",
          "plan_software_name": "text",
          "plan_software_version": "text",
          "scan_device_manufacturer": "text",
          "scan_device_model": "text"
        }
      ],
      "quality": "text",
      "scan": {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      },
      "scan_reports": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text",
          "scan_device_manufacturer": "text",
          "scan_device_model": "text",
          "scan_software_name": "text",
          "scan_software_version": "text"
        }
      ],
      "stress": "text",
      "supplementary_files": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text"
        }
      ],
      "videos": [
        {
          "description": "text",
          "filename": "text",
          "hash": "text"
        }
      ]
    },
    "rough_check": true,
    "sight_no": 1,
    "sight_year": 1,
    "supplementary_tags": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "system_timestamp": "2026-08-08T00:31:58.007Z",
    "three_d_plan_available": false,
    "version_id": "text"
  },
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Update Polished Diamond

patch

/v2/diamond/{id}/polished

Update the polished object of a diamond in the inventory.

Only polished diamonds can be updated with this endpoint.

Path parameters

idany ofRequired

The ID (UUID) of the diamond to update.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID. This field must be unique within the box/shipment the diamond is registered against. Can be updated as long as the the diamond's possession_state is held.

Pattern: ^\S(.*\S)?$

participant_timestampstring · date-timeRequired

Responses

200

Successful Response

application/json

A diamond as returned from V2 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

patch/v2/diamond/{id}/polished

PATCH /v2/diamond/{id}/polished HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 792

{
  "entity_specific_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "participant_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": 1,
    "clarity": "text",
    "colour": "text",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "text",
    "culet_size": "text",
    "cut_grade": "text",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "fancy_colour": "text",
    "fancy_colour_intensity": "text",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "text",
    "fluorescence_intensity": "text",
    "girdle_condition": "text",
    "girdle_thickness_from": "text",
    "girdle_thickness_to": "text",
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "text",
    "shape": "text",
    "symmetry": "text",
    "table_percent": 1,
    "width": 1
  },
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assets": [
    {
      "asset_type": "image",
      "content_hash": "text",
      "created_at": "2026-08-08T00:31:58.007Z",
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "diamond_stage": "polished",
      "extension": "bmp",
      "filename": "text",
      "gallery": "rough",
      "gallery_priority": 0,
      "id": "e1mv3nn4n10kd1lw6mde6sums",
      "image_type": "default",
      "is_hero": false,
      "label": "text",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

Update Rough Diamond

patch

/v2/diamond/{id}/rough

Update the rough object of a diamond in the inventory.

Only rough diamonds can be updated with this endpoint.

Path parameters

idany ofRequired

The ID (UUID) of the diamond to update.

stringOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

string · uuidOptional

Body

box_descriptionstring · nullableOptional

Box description
Tracr class: entity_specific

box_idstring · nullableOptional

System name and ID pairs identifying the source batch for the diamond.
Tracr class: entity_specific

participant_idstring · nullableOptional

Pattern: ^\S(.*\S)?$

participant_timestampstring · date-timeRequired

sight_nointeger · nullableOptional

Sight number
Tracr class: entity_specific

sight_yearinteger · nullableOptional

Sight year
Tracr class: entity_specific

Responses

200

Successful Response

application/json

A diamond as returned from V2 API endpoints.

archived_atstring · date-time · nullableOptional

Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific

assurance_levelstring · enumRequired

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

Possible values:

box_descriptionstring · nullableOptional

Tracr Class: entity_specific

box_idstring · nullableOptional

Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific

current_stagestring · enumRequired

Indicates whether the diamond is rough or polished.
Tracr Class: traceability

Possible values:

diamond_idstringRequired

The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptional

Tracr ID of the diamond's parent.
Tracr Class: traceability

Example: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

idstring · uuidRequired

Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

is_currentbooleanRequired

Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

lifecycle_statestring · enumRequired

Tracr Class: traceability

Possible values:

parent_idstring · uuid · nullableOptional

Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

participant_idstring · nullableOptional

User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific

participant_parent_idstring · nullableOptional

ERP of the diamond's parent.
Tracr Class: entity_specific

participant_timestampstring · date-timeRequired

User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific

possession_statestring · enumRequired

Tracr Class: supplementary

Possible values:

producer_uuidstring · uuidRequired

Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability

rough_checkbooleanRequired

Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary

schema_versionstring · nullableOptional

Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

sight_nointeger · nullableOptional

Tracr Class: entity_specific

sight_yearinteger · nullableOptional

Tracr Class: entity_specific

system_timestampstring · date-timeRequired

Tracr Class: entity_specific

three_d_plan_availablebooleanOptional

Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary

Default: false

unlock_statusstring · enumRequired

Tracr Class: supplementary

Possible values:

verification_descriptionstringOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: verified record

verification_statusstring · enumOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary

Default: VerifiedPossible values:

verification_status_modified_atstring · date-time · nullableOptional

This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific

version_idstringRequired

The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

404

Diamond ID not found. A diamond, with the provided ID, does not exist.

409

Diamond is archived

412

Precondition check failed: The operation cannot be applied to the current state of the diamond.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

patch/v2/diamond/{id}/rough

PATCH /v2/diamond/{id}/rough HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 550

{
  "box_description": "text",
  "box_id": "text",
  "entity_specific_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "participant_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "provenance": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "rough": {
    "carats": 1,
    "colour": "text",
    "fancy_colour": "text",
    "fancy_colour_intensity": "text",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "text",
    "fluorescence_intensity": "text",
    "model": "text",
    "quality": "text",
    "stress": "text"
  },
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "archived_at": "2026-08-08T00:31:58.007Z",
  "assets": [
    {
      "asset_type": "image",
      "content_hash": "text",
      "created_at": "2026-08-08T00:31:58.007Z",
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "diamond_stage": "polished",
      "extension": "bmp",
      "filename": "text",
      "gallery": "rough",
      "gallery_priority": 0,
      "id": "e1mv3nn4n10kd1lw6mde6sums",
      "image_type": "default",
      "is_hero": false,
      "label": "text",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "assurance_level": "assured",
  "box_description": "text",
  "box_id": "text",
  "current_stage": "polished",
  "data_requests": [
    {
      "created_at": "2026-08-08T00:31:58.007Z",
      "data_request_type": "three_d_plan",
      "errors": [
        "text"
      ],
      "id": "text",
      "status": "pending",
      "updated_at": "2026-08-08T00:31:58.007Z"
    }
  ],
  "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
  "diamond_parent_id": "e1mv3nn4n10kd1lw6mde6sums",
  "entity_specific_tags": {
    "dit_session_id": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "grading": [
    {
      "carats": "text",
      "clarity": "FL",
      "colour": "D",
      "crown_angle": "text",
      "crown_height": "text",
      "culet_condition": "P",
      "culet_size": "EL",
      "cut_grade": "I",
      "depth": "text",
      "depth_percent": "text",
      "diameter_maximum": "text",
      "diameter_minimum": "text",
      "display_colour": "text",
      "fancy_colour": "BK",
      "fancy_colour_intensity": "F",
      "fancy_colour_overtone": "text",
      "fluorescence_colour": "B",
      "fluorescence_intensity": "VS",
      "girdle_condition": "P",
      "girdle_thickness_from": "Extremely Thick",
      "girdle_thickness_to": "Extremely Thick",
      "graded_date": "2026-08-08T00:31:58.007Z",
      "grader_certificate_number": "text",
      "grader_clarity_characteristics": "text",
      "grader_colour": "text",
      "grader_inscription_numbers": [
        "text"
      ],
      "grader_report_comments": "text",
      "grader_report_number": "text",
      "grader_report_type": "text",
      "grader_shape": "text",
      "grading_certificate_description": "text",
      "grading_certificate_filename": "text",
      "grading_certificate_hash": "text",
      "grading_lab": "AGS",
      "id": "text",
      "is_active": true,
      "is_selectable": true,
      "length": "text",
      "measurement_text": "text",
      "pavillion_angle": "text",
      "pavillion_percent": "text",
      "polish_quality": "I",
      "shape": "Asscher",
      "source": "gis",
      "supplementary_files": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "symmetry": "I",
      "table_percent": "text",
      "validation_level": "validation",
      "width": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_current": true,
  "lifecycle_state": "destroyed",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "participant_id": "text",
  "participant_parent_id": "text",
  "participant_timestamp": "2026-08-08T00:31:58.007Z",
  "polished": {
    "carats": "text",
    "clarity": "FL",
    "colour": "D",
    "crown_angle": 1,
    "crown_height": 1,
    "culet_condition": "P",
    "culet_size": "EL",
    "cut_grade": "I",
    "depth": 1,
    "depth_percent": 1,
    "diameter_maximum": 1,
    "diameter_minimum": 1,
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "girdle_condition": "P",
    "girdle_thickness_from": "Extremely Thick",
    "girdle_thickness_to": "Extremely Thick",
    "grading_certificates": [
      {
        "description": "text",
        "filename": "text",
        "graded_date": "text",
        "grader_certificate_no": "text",
        "grader_inscription_no": "text",
        "grader_report_no": "text",
        "grading_lab": "text",
        "hash": "text"
      }
    ],
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "length": 1,
    "pavillion_angle": 1,
    "pavillion_percent": 1,
    "polish_quality": "I",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "shape": "Asscher",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "symmetry": "I",
    "table_percent": 1,
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "width": 1
  },
  "polished_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "possession_state": "destroyed",
  "producer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "provenance": {
    "country_code": "text",
    "is_country_code_available": true,
    "is_locked": false,
    "mine_name": "text",
    "provenance_name": "text",
    "provenance_type": "text"
  },
  "rough": {
    "carats": "text",
    "colour": "D",
    "display_colour": "text",
    "fancy_colour": "BK",
    "fancy_colour_intensity": "F",
    "fancy_colour_overtone": "text",
    "fluorescence_colour": "B",
    "fluorescence_intensity": "VS",
    "images": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "image_type": "default"
      }
    ],
    "model": "text",
    "plan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "plan_software_manufacturer": "text",
      "plan_software_name": "text",
      "plan_software_version": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text"
    },
    "plan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "plan_software_manufacturer": "text",
        "plan_software_name": "text",
        "plan_software_version": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text"
      }
    ],
    "quality": "text",
    "scan": {
      "description": "text",
      "filename": "text",
      "hash": "text",
      "scan_device_manufacturer": "text",
      "scan_device_model": "text",
      "scan_software_name": "text",
      "scan_software_version": "text"
    },
    "scan_reports": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text",
        "scan_device_manufacturer": "text",
        "scan_device_model": "text",
        "scan_software_name": "text",
        "scan_software_version": "text"
      }
    ],
    "stress": "text",
    "supplementary_files": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ],
    "videos": [
      {
        "description": "text",
        "filename": "text",
        "hash": "text"
      }
    ]
  },
  "rough_check": true,
  "rough_objective_verification_results": [
    {
      "id": "text",
      "source": "diadna",
      "status": "in_progress"
    }
  ],
  "schema_version": "text",
  "sight_no": 1,
  "sight_year": 1,
  "supplementary_tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "system_timestamp": "2026-08-08T00:31:58.007Z",
  "three_d_plan_available": false,
  "unlock_status": "locked",
  "verification_description": "verified record",
  "verification_status": "Verified",
  "verification_status_modified_at": "2026-08-08T00:31:58.007Z",
  "version_id": "text"
}

PreviousDeprecated NextTransfer

Last updated 23 days ago