> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/api-reference/tracr-api/references/models.md).

# Models

## The ArchiveDiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ArchiveDiamondResult":{"description":"The result of marking a single diamond as archived.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/ArchiveStatus"}},"required":["diamond_id","status"],"title":"ArchiveDiamondResult","type":"object"},"ArchiveStatus":{"description":"Indicates that a diamond was marked as archived successfully or the reason why\nthe diamond could not be marked as archived.","enum":["success","diamond_not_found","diamond_in_terminal_state","diamond_transferred","diamond_in_active_shipment"],"title":"ArchiveStatus","type":"string"}}}}
```

## The ArchiveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ArchiveRequest":{"description":"A list of diamonds to mark as archived.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"ArchiveRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"}}}}
```

## The ArchiveResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ArchiveResponse":{"description":"Aggregated results of marking diamonds as archived.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/ArchiveDiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"ArchiveResponse","type":"object"},"ArchiveDiamondResult":{"description":"The result of marking a single diamond as archived.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/ArchiveStatus"}},"required":["diamond_id","status"],"title":"ArchiveDiamondResult","type":"object"},"ArchiveStatus":{"description":"Indicates that a diamond was marked as archived successfully or the reason why\nthe diamond could not be marked as archived.","enum":["success","diamond_not_found","diamond_in_terminal_state","diamond_transferred","diamond_in_active_shipment"],"title":"ArchiveStatus","type":"string"}}}}
```

## The ArchiveStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ArchiveStatus":{"description":"Indicates that a diamond was marked as archived successfully or the reason why\nthe diamond could not be marked as archived.","enum":["success","diamond_not_found","diamond_in_terminal_state","diamond_transferred","diamond_in_active_shipment"],"title":"ArchiveStatus","type":"string"}}}}
```

## The AssuranceLevel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"}}}}
```

## The Body\_upload\_diamond\_image\_diamonds\_\_id\_\_files\_images\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_image_diamonds__id__files_images_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Valid values: default, 3d, b2b, heart, arrow, aset_scope, plot, face_up, dark_field, ideal_scope, fluorescence, inclusion_map, diagram, other. Default: default"}},"required":["file"],"title":"Body_upload_diamond_image_diamonds__id__files_images_post","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"}}}}
```

## The Body\_upload\_diamond\_plan\_diamonds\_\_id\_\_files\_plan\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_plan_diamonds__id__files_plan_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Version"}},"required":["file"],"title":"Body_upload_diamond_plan_diamonds__id__files_plan_post","type":"object"}}}}
```

## The Body\_upload\_diamond\_plan\_report\_diamonds\_\_id\_\_files\_plan\_reports\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_plan_report_diamonds__id__files_plan_reports_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Model"}},"required":["file"],"title":"Body_upload_diamond_plan_report_diamonds__id__files_plan_reports_post","type":"object"}}}}
```

## The Body\_upload\_diamond\_scan\_diamonds\_\_id\_\_files\_scan\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_scan_diamonds__id__files_scan_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Model"}},"required":["file"],"title":"Body_upload_diamond_scan_diamonds__id__files_scan_post","type":"object"}}}}
```

## The Body\_upload\_diamond\_scan\_report\_diamonds\_\_id\_\_files\_scan\_reports\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_scan_report_diamonds__id__files_scan_reports_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Software Version"}},"required":["file"],"title":"Body_upload_diamond_scan_report_diamonds__id__files_scan_reports_post","type":"object"}}}}
```

## The Body\_upload\_diamond\_supplementary\_file\_diamonds\_\_id\_\_files\_supplementary\_files\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_supplementary_file_diamonds__id__files_supplementary_files_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"}},"required":["file"],"title":"Body_upload_diamond_supplementary_file_diamonds__id__files_supplementary_files_post","type":"object"}}}}
```

## The Body\_upload\_diamond\_video\_diamonds\_\_id\_\_files\_videos\_post object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Body_upload_diamond_video_diamonds__id__files_videos_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"}},"required":["file"],"title":"Body_upload_diamond_video_diamonds__id__files_videos_post","type":"object"}}}}
```

## The BulkDiamondAssetDeleteRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteRequest":{"description":"A request to delete one or more diamond assets.","properties":{"assets":{"description":"The diamond assets for which to process.","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteRequestAsset"},"title":"Assets","type":"array"}},"required":["assets"],"title":"BulkDiamondAssetDeleteRequest","type":"object"},"BulkDiamondAssetDeleteRequestAsset":{"description":"A diamond asset contained within a bulk diamond asset deletion request.","properties":{"diamond_asset_id":{"description":"The ID of the diamond asset to delete.","title":"Diamond Asset Id","type":"string"}},"required":["diamond_asset_id"],"title":"BulkDiamondAssetDeleteRequestAsset","type":"object"}}}}
```

## The BulkDiamondAssetDeleteRequestAsset object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteRequestAsset":{"description":"A diamond asset contained within a bulk diamond asset deletion request.","properties":{"diamond_asset_id":{"description":"The ID of the diamond asset to delete.","title":"Diamond Asset Id","type":"string"}},"required":["diamond_asset_id"],"title":"BulkDiamondAssetDeleteRequestAsset","type":"object"}}}}
```

## The BulkDiamondAssetDeleteResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteResponse":{"description":"A response from the /bulk/diamond-asset/delete endpoint containing the status\nof each deleted diamond.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResult"},"title":"Results","type":"array"}},"required":["results"],"title":"BulkDiamondAssetDeleteResponse","type":"object"},"BulkDiamondAssetDeleteResult":{"description":"The result of deleting a single diamond asset.","properties":{"diamond_asset_id":{"description":"The ID of the diamond asset to which this result pertains.","title":"Diamond Asset Id","type":"string"},"diamond_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"The ID of diamond to which this result pertains. In the case that the asset could not be found, this will be null.","title":"Diamond Id"},"errors":{"description":"Any errors preventing the deletion of the diamond asset. In the case that the error(s) are resolvable many errors may be returned. ","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultError"},"title":"Errors","type":"array"},"status":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteStatus","description":"The status of the deletion."}},"required":["diamond_asset_id","diamond_id","status"],"title":"BulkDiamondAssetDeleteResult","type":"object"},"BulkDiamondAssetDeleteResultError":{"description":"An error returned if the deletion of a diamond asset fails.","properties":{"error_code":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultErrorCode","description":"An error code representing the error that occurred."},"message":{"description":"A human readable error message explaining the error code. Error messages can change over time.","title":"Message","type":"string"}},"required":["error_code","message"],"title":"BulkDiamondAssetDeleteResultError","type":"object"},"BulkDiamondAssetDeleteResultErrorCode":{"description":"Unique error codes representing errors that occur when deleting diamond assets.","enum":["diamond_asset_not_found","diamond_archived","diamond_in_transfer","diamond_transferred","invalid_diamond_asset_type","legacy_diamond_asset"],"title":"BulkDiamondAssetDeleteResultErrorCode","type":"string"},"BulkDiamondAssetDeleteStatus":{"description":"Overarching status of a bulk diamond asset deletion request.","enum":["success","error"],"title":"BulkDiamondAssetDeleteStatus","type":"string"}}}}
```

## The BulkDiamondAssetDeleteResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteResult":{"description":"The result of deleting a single diamond asset.","properties":{"diamond_asset_id":{"description":"The ID of the diamond asset to which this result pertains.","title":"Diamond Asset Id","type":"string"},"diamond_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"The ID of diamond to which this result pertains. In the case that the asset could not be found, this will be null.","title":"Diamond Id"},"errors":{"description":"Any errors preventing the deletion of the diamond asset. In the case that the error(s) are resolvable many errors may be returned. ","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultError"},"title":"Errors","type":"array"},"status":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteStatus","description":"The status of the deletion."}},"required":["diamond_asset_id","diamond_id","status"],"title":"BulkDiamondAssetDeleteResult","type":"object"},"BulkDiamondAssetDeleteResultError":{"description":"An error returned if the deletion of a diamond asset fails.","properties":{"error_code":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultErrorCode","description":"An error code representing the error that occurred."},"message":{"description":"A human readable error message explaining the error code. Error messages can change over time.","title":"Message","type":"string"}},"required":["error_code","message"],"title":"BulkDiamondAssetDeleteResultError","type":"object"},"BulkDiamondAssetDeleteResultErrorCode":{"description":"Unique error codes representing errors that occur when deleting diamond assets.","enum":["diamond_asset_not_found","diamond_archived","diamond_in_transfer","diamond_transferred","invalid_diamond_asset_type","legacy_diamond_asset"],"title":"BulkDiamondAssetDeleteResultErrorCode","type":"string"},"BulkDiamondAssetDeleteStatus":{"description":"Overarching status of a bulk diamond asset deletion request.","enum":["success","error"],"title":"BulkDiamondAssetDeleteStatus","type":"string"}}}}
```

## The BulkDiamondAssetDeleteResultError object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteResultError":{"description":"An error returned if the deletion of a diamond asset fails.","properties":{"error_code":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultErrorCode","description":"An error code representing the error that occurred."},"message":{"description":"A human readable error message explaining the error code. Error messages can change over time.","title":"Message","type":"string"}},"required":["error_code","message"],"title":"BulkDiamondAssetDeleteResultError","type":"object"},"BulkDiamondAssetDeleteResultErrorCode":{"description":"Unique error codes representing errors that occur when deleting diamond assets.","enum":["diamond_asset_not_found","diamond_archived","diamond_in_transfer","diamond_transferred","invalid_diamond_asset_type","legacy_diamond_asset"],"title":"BulkDiamondAssetDeleteResultErrorCode","type":"string"}}}}
```

## The BulkDiamondAssetDeleteResultErrorCode object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteResultErrorCode":{"description":"Unique error codes representing errors that occur when deleting diamond assets.","enum":["diamond_asset_not_found","diamond_archived","diamond_in_transfer","diamond_transferred","invalid_diamond_asset_type","legacy_diamond_asset"],"title":"BulkDiamondAssetDeleteResultErrorCode","type":"string"}}}}
```

## The BulkDiamondAssetDeleteStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"BulkDiamondAssetDeleteStatus":{"description":"Overarching status of a bulk diamond asset deletion request.","enum":["success","error"],"title":"BulkDiamondAssetDeleteStatus","type":"string"}}}}
```

## The Clarity object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"}}}}
```

## The Colour object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"}}}}
```

## The CreateRoughChildDiamond object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"CreateRoughChildDiamond":{"additionalProperties":false,"description":"Describes what's mandatory for the create rough child diamond endpoint,\nregardless of a particular instance's configuration.","properties":{"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.<br/>Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.<br/>Tracr class: entity_specific","nullable":false,"pattern":"^\\S(.*\\S)?$","title":"Participant Id","type":"string"},"participant_timestamp":{"description":"A timestamp (in ISO8601 format) representing the real world time that the change happened.<br/>Tracr class: entity_specific","format":"date-time","nullable":false,"title":"Participant Timestamp","type":"string"},"rough":{"$ref":"#/components/schemas/RoughSchema"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags<br/>Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_id","participant_timestamp","rough"],"title":"CreateRoughChildDiamond","type":"object"},"RoughSchema":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":false,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale<br/>Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.<br/>Tracr class: traceability","nullable":true,"title":"Stress"}},"required":["carats"],"title":"RoughSchema","type":"object"}}}}
```

## The CreateRoughDiamond object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"CreateRoughDiamond":{"additionalProperties":false,"description":"Describes what's mandatory for the create rough diamond endpoint,\nregardless of a particular instance's configuration.","properties":{"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","default":"assured"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Box description<br/>Tracr class: entity_specific","nullable":true,"title":"Box Description"},"box_id":{"description":"System name and ID pairs identifying the source batch for the diamond.<br/>Tracr class: entity_specific","nullable":false,"title":"Box Id","type":"string"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}]},"participant_id":{"description":"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.","nullable":false,"pattern":"^\\S(.*\\S)?$","title":"Participant Id","type":"string"},"participant_timestamp":{"description":"A timestamp (in ISO8601 format) representing the real world time that the change happened.<br/>Tracr class: entity_specific","format":"date-time","nullable":false,"title":"Participant Timestamp","type":"string"},"rough":{"$ref":"#/components/schemas/RoughSchema"},"sight_no":{"anyOf":[{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight number<br/>Tracr class: entity_specific","nullable":true},{"type":"null"}],"title":"Sight No"},"sight_year":{"anyOf":[{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight year<br/>Tracr class: entity_specific","nullable":true},{"type":"null"}],"title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags<br/>Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["box_id","participant_id","participant_timestamp","rough"],"title":"CreateRoughDiamond","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"RoughSchema":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":false,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale<br/>Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.<br/>Tracr class: traceability","nullable":true,"title":"Stress"}},"required":["carats"],"title":"RoughSchema","type":"object"}}}}
```

## The CuletCondition object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"}}}}
```

## The CuletSize object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"}}}}
```

## The CurrentStage object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"}}}}
```

## The CutGrade object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"}}}}
```

## The DeleteRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteRequest":{"properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DeleteRequestDiamond"},"maxItems":1000,"title":"Diamonds","type":"array"},"dry_run":{"default":false,"description":"If true, no diamonds will be deleted. The API will return the response as if it did.","title":"Dry Run","type":"boolean"}},"required":["diamonds"],"title":"DeleteRequest","type":"object"},"DeleteRequestDiamond":{"properties":{"delete_descendants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Delete Descendants"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DeleteRequestDiamond","type":"object"}}}}
```

## The DeleteRequestDiamond object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteRequestDiamond":{"properties":{"delete_descendants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Delete Descendants"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DeleteRequestDiamond","type":"object"}}}}
```

## The DeleteResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteResponse":{"properties":{"results":{"items":{"anyOf":[{"$ref":"#/components/schemas/DeleteResultError"},{"$ref":"#/components/schemas/DeleteResultSuccess"}]},"title":"Results","type":"array"}},"required":["results"],"title":"DeleteResponse","type":"object"},"DeleteResultError":{"properties":{"descendants":{"items":{"$ref":"#/components/schemas/DeleteResponseDiamond"},"title":"Descendants","type":"array"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"error":{"title":"Error","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"status":{"$ref":"#/components/schemas/DeleteResultErrorStatus"}},"required":["diamond_id","status","descendants","error"],"title":"DeleteResultError","type":"object"},"DeleteResponseDiamond":{"properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"}},"required":["diamond_id"],"title":"DeleteResponseDiamond","type":"object"},"DeleteResultErrorStatus":{"description":"Defines the different errors possible when deleting a diamond.","enum":["descendants_in_active_shipment","descendants_transferred","descendants_unlocked","descendants_archived","diamond_has_descendants","diamond_in_active_shipment","diamond_not_found","diamond_transferred","diamond_unlocked"],"title":"DeleteResultErrorStatus","type":"string"},"DeleteResultSuccess":{"properties":{"descendants":{"items":{"$ref":"#/components/schemas/DeleteResponseDiamond"},"title":"Descendants","type":"array"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"status":{"$ref":"#/components/schemas/DeleteResultSuccessStatus","default":"success"}},"required":["diamond_id","descendants"],"title":"DeleteResultSuccess","type":"object"},"DeleteResultSuccessStatus":{"description":"Defines the possible statuses when a diamond has been successfully\ndeleted.","enum":["success"],"title":"DeleteResultSuccessStatus","type":"string"}}}}
```

## The DeleteResponseDiamond object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteResponseDiamond":{"properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"}},"required":["diamond_id"],"title":"DeleteResponseDiamond","type":"object"}}}}
```

## The DeleteResultError object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteResultError":{"properties":{"descendants":{"items":{"$ref":"#/components/schemas/DeleteResponseDiamond"},"title":"Descendants","type":"array"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"error":{"title":"Error","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"status":{"$ref":"#/components/schemas/DeleteResultErrorStatus"}},"required":["diamond_id","status","descendants","error"],"title":"DeleteResultError","type":"object"},"DeleteResponseDiamond":{"properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"}},"required":["diamond_id"],"title":"DeleteResponseDiamond","type":"object"},"DeleteResultErrorStatus":{"description":"Defines the different errors possible when deleting a diamond.","enum":["descendants_in_active_shipment","descendants_transferred","descendants_unlocked","descendants_archived","diamond_has_descendants","diamond_in_active_shipment","diamond_not_found","diamond_transferred","diamond_unlocked"],"title":"DeleteResultErrorStatus","type":"string"}}}}
```

## The DeleteResultErrorStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteResultErrorStatus":{"description":"Defines the different errors possible when deleting a diamond.","enum":["descendants_in_active_shipment","descendants_transferred","descendants_unlocked","descendants_archived","diamond_has_descendants","diamond_in_active_shipment","diamond_not_found","diamond_transferred","diamond_unlocked"],"title":"DeleteResultErrorStatus","type":"string"}}}}
```

## The DeleteResultSuccess object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteResultSuccess":{"properties":{"descendants":{"items":{"$ref":"#/components/schemas/DeleteResponseDiamond"},"title":"Descendants","type":"array"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"status":{"$ref":"#/components/schemas/DeleteResultSuccessStatus","default":"success"}},"required":["diamond_id","descendants"],"title":"DeleteResultSuccess","type":"object"},"DeleteResponseDiamond":{"properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"}},"required":["diamond_id"],"title":"DeleteResponseDiamond","type":"object"},"DeleteResultSuccessStatus":{"description":"Defines the possible statuses when a diamond has been successfully\ndeleted.","enum":["success"],"title":"DeleteResultSuccessStatus","type":"string"}}}}
```

## The DeleteResultSuccessStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DeleteResultSuccessStatus":{"description":"Defines the possible statuses when a diamond has been successfully\ndeleted.","enum":["success"],"title":"DeleteResultSuccessStatus","type":"string"}}}}
```

## The DiamondAssetGallery object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2ImageResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"}}}}
```

## The DiamondAssetV2InscriptionNumberResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2PlanReportResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2PlanResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2ScanReportResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2ScanResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2SupplementaryResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2ThreeDPlanResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondAssetV2VideoResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}}
```

## The DiamondDataRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"}}}}
```

## The DiamondDataRequestStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"}}}}
```

## The DiamondDataRequestType object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"}}}}
```

## The DiamondIDOnly object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"}}}}
```

## The DiamondIdWithInscriptionNumber object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondIdWithInscriptionNumber":{"description":"An object containing a Diamond ID and associated inscription numbers.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"inscription_number":{"title":"Inscription Number","type":"string"}},"required":["diamond_id","inscription_number"],"title":"DiamondIdWithInscriptionNumber","type":"object"}}}}
```

## The DiamondStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondStatus":{"description":"Derived inventory status of a diamond, mirroring the portal-api status column.\n\nValues:\n- ``transferring``: The diamond is in an active outbound transfer.\n- ``unavailable``: Polished, not unlocked, rough OV passed but polished OV is still\n  required (mandate_polished_check is active and carats ≥ threshold).\n- ``locked``: Polished diamond that has not yet been unlocked.\n- ``action_required_missing_rough_scan``: Top-level rough diamond above the carat\n  threshold that is missing its rough scan.\n- ``action_required_unconfirmed_rough_scan``: Top-level rough diamond above the\n  carat threshold whose rough OV returned a failure result.\n- ``processing_rough_objective_verification``: Rough OV for this diamond is in progress.\n- ``processing_polished_objective_verification``: Polished OV for this diamond is in progress.\n- ``available``: All other cases — the diamond is available for use.","enum":["transferring","unavailable","locked","action_required_missing_rough_scan","action_required_unconfirmed_rough_scan","processing_rough_objective_verification","processing_polished_objective_verification","available"],"title":"DiamondStatus","type":"string"}}}}
```

## The DiamondUnlockResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondUnlockResult":{"description":"Represents the result of an attempt to unlock a single diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondUnlockResultStatus"}},"required":["diamond_id","status"],"title":"DiamondUnlockResult","type":"object"},"DiamondUnlockResultStatus":{"description":"Represents the possible responses to an attempt to unlock a diamond.","enum":["diamond_does_not_exist","diamond_cannot_be_unlocked","missing_unlock_requirement","success"],"title":"DiamondUnlockResultStatus","type":"string"}}}}
```

## The DiamondUnlockResultStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondUnlockResultStatus":{"description":"Represents the possible responses to an attempt to unlock a diamond.","enum":["diamond_does_not_exist","diamond_cannot_be_unlocked","missing_unlock_requirement","success"],"title":"DiamondUnlockResultStatus","type":"string"}}}}
```

## The DiamondUnlockStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"}}}}
```

## The DiamondV1 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.</br>Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by <code>diamond_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"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.</br>Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by <code>diamond_parent_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.</br>Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"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.</br>Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}}
```

## The DiamondV1Polished object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"}}}}
```

## The DiamondV1Provenance object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"}}}}
```

## The DiamondV1Rough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"}}}}
```

## The DiamondV2 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2":{"description":"A diamond as returned from V2 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.</br>Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by <code>diamond_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"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.</br>Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by <code>diamond_parent_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.</br>Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"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.</br>Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV2","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}}
```

## The DiamondV2Bucket object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Bucket":{"description":"A carat weight bucket.","properties":{"exclusive_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusive End"},"inclusive_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inclusive Start"}},"required":["inclusive_start","exclusive_end"],"title":"DiamondV2Bucket","type":"object"}}}}
```

## The DiamondV2Detail object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Detail":{"description":"Extended diamond details as returned from the V2 diamond detail endpoint.\n\nThis model extends DiamondV2 with additional fields:\n- top_rough: Details of the diamond's parent rough diamond (if it exists)\n- status: The possession state of the diamond (same as used in inventory)","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.</br>Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by <code>diamond_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"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.</br>Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by <code>diamond_parent_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.</br>Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"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.</br>Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"status":{"$ref":"#/components/schemas/DiamondStatus","description":"The inventory status of the diamond"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"top_rough":{"anyOf":[{"$ref":"#/components/schemas/DiamondV2TopRough"},{"type":"null"}],"description":"Details of the diamond's top rough"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id","status"],"title":"DiamondV2Detail","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondStatus":{"description":"Derived inventory status of a diamond, mirroring the portal-api status column.\n\nValues:\n- ``transferring``: The diamond is in an active outbound transfer.\n- ``unavailable``: Polished, not unlocked, rough OV passed but polished OV is still\n  required (mandate_polished_check is active and carats ≥ threshold).\n- ``locked``: Polished diamond that has not yet been unlocked.\n- ``action_required_missing_rough_scan``: Top-level rough diamond above the carat\n  threshold that is missing its rough scan.\n- ``action_required_unconfirmed_rough_scan``: Top-level rough diamond above the\n  carat threshold whose rough OV returned a failure result.\n- ``processing_rough_objective_verification``: Rough OV for this diamond is in progress.\n- ``processing_polished_objective_verification``: Polished OV for this diamond is in progress.\n- ``available``: All other cases — the diamond is available for use.","enum":["transferring","unavailable","locked","action_required_missing_rough_scan","action_required_unconfirmed_rough_scan","processing_rough_objective_verification","processing_polished_objective_verification","available"],"title":"DiamondStatus","type":"string"},"DiamondV2TopRough":{"properties":{"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["current_stage","diamond_id","entity_specific_tags","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","system_timestamp","version_id"],"title":"DiamondV2TopRough","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}}
```

## The DiamondV2Filter object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Filter":{"description":"The filter values supported by a field.","properties":{"bucket":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiamondV2Bucket"},"type":"array"},{"type":"null"}],"title":"Bucket"},"distinct":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Distinct"},"range":{"anyOf":[{"$ref":"#/components/schemas/DiamondV2Range"},{"type":"null"}]}},"title":"DiamondV2Filter","type":"object"},"DiamondV2Bucket":{"description":"A carat weight bucket.","properties":{"exclusive_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusive End"},"inclusive_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inclusive Start"}},"required":["inclusive_start","exclusive_end"],"title":"DiamondV2Bucket","type":"object"},"DiamondV2Range":{"description":"A range of values.","properties":{"max":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Max"},"min":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Min"}},"required":["min","max"],"title":"DiamondV2Range","type":"object"}}}}
```

## The DiamondV2FiltersResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2FiltersResponse":{"description":"Result filter values found across all diamonds.","properties":{"results":{"additionalProperties":{"$ref":"#/components/schemas/DiamondV2Filter"},"title":"Results","type":"object"}},"required":["results"],"title":"DiamondV2FiltersResponse","type":"object"},"DiamondV2Filter":{"description":"The filter values supported by a field.","properties":{"bucket":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiamondV2Bucket"},"type":"array"},{"type":"null"}],"title":"Bucket"},"distinct":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Distinct"},"range":{"anyOf":[{"$ref":"#/components/schemas/DiamondV2Range"},{"type":"null"}]}},"title":"DiamondV2Filter","type":"object"},"DiamondV2Bucket":{"description":"A carat weight bucket.","properties":{"exclusive_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusive End"},"inclusive_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inclusive Start"}},"required":["inclusive_start","exclusive_end"],"title":"DiamondV2Bucket","type":"object"},"DiamondV2Range":{"description":"A range of values.","properties":{"max":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Max"},"min":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Min"}},"required":["min","max"],"title":"DiamondV2Range","type":"object"}}}}
```

## The DiamondV2Polished object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"}}}}
```

## The DiamondV2Provenance object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"}}}}
```

## The DiamondV2Range object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Range":{"description":"A range of values.","properties":{"max":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Max"},"min":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Min"}},"required":["min","max"],"title":"DiamondV2Range","type":"object"}}}}
```

## The DiamondV2Rough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"}}}}
```

## The DiamondV2TopRough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondV2TopRough":{"properties":{"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["current_stage","diamond_id","entity_specific_tags","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","system_timestamp","version_id"],"title":"DiamondV2TopRough","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"}}}}
```

## The DiamondsPaginator\_DiamondV1\_ object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondsPaginator_DiamondV1_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page. Excluded from the response if there is no next page.","title":"Next"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the current page.","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"The total number of pages.","title":"Pages"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the previous page. Excluded from the response if there is no previous page.","title":"Previous"},"results":{"description":"The diamond data.","items":{"$ref":"#/components/schemas/DiamondV1"},"title":"Results","type":"array"},"total":{"description":"The total number of diamonds across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"DiamondsPaginator[DiamondV1]","type":"object"},"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.</br>Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by <code>diamond_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"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.</br>Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by <code>diamond_parent_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.</br>Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"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.</br>Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}}
```

## The DiamondsV2ListResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"DiamondsV2ListResponse":{"description":"A paginated response containing zero or more diamonds.","properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page.","title":"Next"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the current page.","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"The total number of pages.","title":"Pages"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL of the previous page.","title":"Previous"},"results":{"description":"The results for the current page.","items":{"$ref":"#/components/schemas/DiamondV2"},"title":"Results","type":"array"},"total":{"description":"The total number of results across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"DiamondsV2ListResponse","type":"object"},"DiamondV2":{"description":"A diamond as returned from V2 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.</br>Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.</br>Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.</br>Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.</br>Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.</br>Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by <code>diamond_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"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.</br>Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by <code>diamond_parent_id</code>. This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.</br>Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.</br>Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.</br>Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.</br>Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.</br>Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.</br>Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"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.</br>Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.</br>Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.</br>Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.</br>Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV2","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n<br>\n<br>\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.<br/>Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine<br/>Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name<br/>Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'<br/>Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}}
```

## The EntitySpecificTags object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"}}}}
```

## The FancyColour object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"}}}}
```

## The FancyColourIntensity object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"}}}}
```

## The FileRef object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"}}}}
```

## The FileUploadResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}}
```

## The FluorescenceColour object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"}}}}
```

## The FluorescenceIntensity object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"}}}}
```

## The GirdleCondition object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"}}}}
```

## The GirdleThickness object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"}}}}
```

## The GradedMeasurementSource object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"}}}}
```

## The GradedMeasurementUploadResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GradedMeasurementUploadResponse":{"additionalProperties":false,"properties":{"graded_measurement_id":{"description":"Graded Measurement ID.","title":"Graded Measurement Id","type":"string"},"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash","graded_measurement_id"],"title":"GradedMeasurementUploadResponse","type":"object"}}}}
```

## The GradingCertificateRef object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"}}}}
```

## The GradingCertificateUploadParams object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GradingCertificateUploadParams":{"description":"The form usede by the upload_grading_certificate_endpoint.","properties":{"carats":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"certificate_file":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"description":"The grading certificate file.","title":"Certificate File"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"clarity_characteristics_diagram":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"title":"Clarity Characteristics Diagram"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"file":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"deprecated":true,"description":"The grading certificate file. This field is deprecated, use <code>certificate_file</code> instead.","title":"File"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate No"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report No"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"Other","title":"Grading Lab"},"length":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"proportions_diagram":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"title":"Proportions Diagram"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"title":"GradingCertificateUploadParams","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}}
```

## The GradingDataView object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}}
```

## The GradingLab object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"}}}}
```

## The HTTPValidationError object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## The ImageFileExtension object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"}}}}
```

## The ImageRef object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"}}}}
```

## The ImageType object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"}}}}
```

## The InboundDiamondState object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"}}}}
```

## The InboundShipmentDiamondModel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"InboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"}}}}
```

## The InboundShipmentDiamondV2 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentDiamondV2":{"description":"A diamond within an inbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which this Tracr instance was notified of the diamond being part of an inbound shipment. Not all diamonds are sent at the same time, so this timestamp will differ between diamonds in the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"polished":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState","description":"The stage of transfer that the diamond is currently in. The terminal states are transferred, cancelled, and rejected. All intermediate states mean the transfer is in progress."},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","polished","rough","transfer_state","updated_at"],"title":"InboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"InboundShipmentDiamondV2Polished":{"description":"Summary of an inbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","inscription_numbers","report_numbers","shape"],"title":"InboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundShipmentDiamondV2Rough":{"description":"Summary of an inbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"InboundShipmentDiamondV2Rough","type":"object"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"}}}}
```

## The InboundShipmentDiamondV2Polished object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentDiamondV2Polished":{"description":"Summary of an inbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","inscription_numbers","report_numbers","shape"],"title":"InboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"}}}}
```

## The InboundShipmentDiamondV2Rough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentDiamondV2Rough":{"description":"Summary of an inbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"InboundShipmentDiamondV2Rough","type":"object"}}}}
```

## The InboundShipmentModel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentModel":{"description":"Details of the inbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/InboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"sender":{"title":"Sender","type":"string"}},"required":["id","name","sender","diamonds","created_at"],"title":"InboundShipmentModel","type":"object"},"InboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"InboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"}}}}
```

## The InboundShipmentStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentStatus":{"description":"Derived statuses for inbound shipments.","enum":["action_required","cancelled","complete","empty","incomplete","processing","rejected"],"title":"InboundShipmentStatus","type":"string"}}}}
```

## The InboundShipmentV2 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentV2":{"description":"An inbound shipment containing diamonds that can be transferred to this Tracr instance.\n\nInbound diamonds can be accepted or rejected using the transfer API collection.\n\nThis schema is specific to the /v2/shipment collection.","properties":{"created_at":{"description":"The time at which this Tracr instance was first notified of the shipment.","format":"date-time","title":"Created At","type":"string"},"diamonds":{"description":"A list of all diamonds contained within this shipment.","items":{"$ref":"#/components/schemas/InboundShipmentDiamondV2"},"title":"Diamonds","type":"array"},"id":{"description":"The shipment's globally unique identifier.","title":"Id","type":"string"},"name":{"description":"The shipment's name, populated by the sender.","title":"Name","type":"string"},"sender":{"description":"The API URL of the participant who created this shipment.","title":"Sender","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"Whether the shipment contains rough or polished diamonds."},"status":{"$ref":"#/components/schemas/InboundShipmentStatus","description":"Aggregated status of the diamonds within a shipment."},"total_diamonds":{"description":"The total number of diamonds in the shipment. This can be larger than the count of diamonds in the shipment if the shipment is still being received.","title":"Total Diamonds","type":"integer"}},"required":["id","name","sender","diamonds","created_at","shipment_type","status","total_diamonds"],"title":"InboundShipmentV2","type":"object"},"InboundShipmentDiamondV2":{"description":"A diamond within an inbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which this Tracr instance was notified of the diamond being part of an inbound shipment. Not all diamonds are sent at the same time, so this timestamp will differ between diamonds in the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"polished":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState","description":"The stage of transfer that the diamond is currently in. The terminal states are transferred, cancelled, and rejected. All intermediate states mean the transfer is in progress."},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","polished","rough","transfer_state","updated_at"],"title":"InboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"InboundShipmentDiamondV2Polished":{"description":"Summary of an inbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","inscription_numbers","report_numbers","shape"],"title":"InboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundShipmentDiamondV2Rough":{"description":"Summary of an inbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"InboundShipmentDiamondV2Rough","type":"object"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"},"InboundShipmentStatus":{"description":"Derived statuses for inbound shipments.","enum":["action_required","cancelled","complete","empty","incomplete","processing","rejected"],"title":"InboundShipmentStatus","type":"string"}}}}
```

## The InboundShipmentV2DetailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentV2DetailResponse":{"description":"A response containing a single inbound shipment.","properties":{"created_at":{"description":"The time at which this Tracr instance was first notified of the shipment.","format":"date-time","title":"Created At","type":"string"},"diamonds":{"description":"A list of all diamonds contained within this shipment.","items":{"$ref":"#/components/schemas/InboundShipmentDiamondV2"},"title":"Diamonds","type":"array"},"id":{"description":"The shipment's globally unique identifier.","title":"Id","type":"string"},"name":{"description":"The shipment's name, populated by the sender.","title":"Name","type":"string"},"sender":{"description":"The API URL of the participant who created this shipment.","title":"Sender","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"Whether the shipment contains rough or polished diamonds."},"status":{"$ref":"#/components/schemas/InboundShipmentStatus","description":"Aggregated status of the diamonds within a shipment."},"total_diamonds":{"description":"The total number of diamonds in the shipment. This can be larger than the count of diamonds in the shipment if the shipment is still being received.","title":"Total Diamonds","type":"integer"}},"required":["id","name","sender","diamonds","created_at","shipment_type","status","total_diamonds"],"title":"InboundShipmentV2DetailResponse","type":"object"},"InboundShipmentDiamondV2":{"description":"A diamond within an inbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which this Tracr instance was notified of the diamond being part of an inbound shipment. Not all diamonds are sent at the same time, so this timestamp will differ between diamonds in the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"polished":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState","description":"The stage of transfer that the diamond is currently in. The terminal states are transferred, cancelled, and rejected. All intermediate states mean the transfer is in progress."},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","polished","rough","transfer_state","updated_at"],"title":"InboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"InboundShipmentDiamondV2Polished":{"description":"Summary of an inbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","inscription_numbers","report_numbers","shape"],"title":"InboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundShipmentDiamondV2Rough":{"description":"Summary of an inbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"InboundShipmentDiamondV2Rough","type":"object"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"},"InboundShipmentStatus":{"description":"Derived statuses for inbound shipments.","enum":["action_required","cancelled","complete","empty","incomplete","processing","rejected"],"title":"InboundShipmentStatus","type":"string"}}}}
```

## The InboundShipmentV2FiltersResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentV2FiltersResponse":{"description":"Dynamically populated values for inbound shipment filters.","properties":{"shipment_type":{"items":{"$ref":"#/components/schemas/ShipmentLifecycleState"},"title":"Shipment Type","type":"array"},"status":{"items":{"$ref":"#/components/schemas/InboundShipmentStatus"},"title":"Status","type":"array"}},"required":["shipment_type","status"],"title":"InboundShipmentV2FiltersResponse","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"InboundShipmentStatus":{"description":"Derived statuses for inbound shipments.","enum":["action_required","cancelled","complete","empty","incomplete","processing","rejected"],"title":"InboundShipmentStatus","type":"string"}}}}
```

## The InboundShipmentV2ListResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentV2ListResponse":{"description":"A paginated response containing zero or more inbound shipments.","properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page.","title":"Next"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the current page.","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"The total number of pages.","title":"Pages"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL of the previous page.","title":"Previous"},"results":{"description":"The results for the current page.","items":{"$ref":"#/components/schemas/InboundShipmentV2"},"title":"Results","type":"array"},"total":{"description":"The total number of results across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"InboundShipmentV2ListResponse","type":"object"},"InboundShipmentV2":{"description":"An inbound shipment containing diamonds that can be transferred to this Tracr instance.\n\nInbound diamonds can be accepted or rejected using the transfer API collection.\n\nThis schema is specific to the /v2/shipment collection.","properties":{"created_at":{"description":"The time at which this Tracr instance was first notified of the shipment.","format":"date-time","title":"Created At","type":"string"},"diamonds":{"description":"A list of all diamonds contained within this shipment.","items":{"$ref":"#/components/schemas/InboundShipmentDiamondV2"},"title":"Diamonds","type":"array"},"id":{"description":"The shipment's globally unique identifier.","title":"Id","type":"string"},"name":{"description":"The shipment's name, populated by the sender.","title":"Name","type":"string"},"sender":{"description":"The API URL of the participant who created this shipment.","title":"Sender","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"Whether the shipment contains rough or polished diamonds."},"status":{"$ref":"#/components/schemas/InboundShipmentStatus","description":"Aggregated status of the diamonds within a shipment."},"total_diamonds":{"description":"The total number of diamonds in the shipment. This can be larger than the count of diamonds in the shipment if the shipment is still being received.","title":"Total Diamonds","type":"integer"}},"required":["id","name","sender","diamonds","created_at","shipment_type","status","total_diamonds"],"title":"InboundShipmentV2","type":"object"},"InboundShipmentDiamondV2":{"description":"A diamond within an inbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which this Tracr instance was notified of the diamond being part of an inbound shipment. Not all diamonds are sent at the same time, so this timestamp will differ between diamonds in the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"polished":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState","description":"The stage of transfer that the diamond is currently in. The terminal states are transferred, cancelled, and rejected. All intermediate states mean the transfer is in progress."},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","polished","rough","transfer_state","updated_at"],"title":"InboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"InboundShipmentDiamondV2Polished":{"description":"Summary of an inbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","inscription_numbers","report_numbers","shape"],"title":"InboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundShipmentDiamondV2Rough":{"description":"Summary of an inbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"InboundShipmentDiamondV2Rough","type":"object"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"},"InboundShipmentStatus":{"description":"Derived statuses for inbound shipments.","enum":["action_required","cancelled","complete","empty","incomplete","processing","rejected"],"title":"InboundShipmentStatus","type":"string"}}}}
```

## The InboundShipmentsModel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"InboundShipmentsModel":{"description":"Details of multiple inbound shipments and the diamonds within them.","properties":{"items":{"items":{"$ref":"#/components/schemas/InboundShipmentModel"},"title":"Items","type":"array"}},"required":["items"],"title":"InboundShipmentsModel","type":"object"},"InboundShipmentModel":{"description":"Details of the inbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/InboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"sender":{"title":"Sender","type":"string"}},"required":["id","name","sender","diamonds","created_at"],"title":"InboundShipmentModel","type":"object"},"InboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"InboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"}}}}
```

## The LifecycleState object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"}}}}
```

## The ObjectiveVerificationData object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"}}}}
```

## The ObjectiveVerificationDataSource object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"}}}}
```

## The ObjectiveVerificationDataStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"}}}}
```

## The OutboundDiamondState object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"}}}}
```

## The OutboundShipmentDiamondModel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"OutboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"}}}}
```

## The OutboundShipmentDiamondV2 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentDiamondV2":{"description":"A diamond within an outbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which the diamond was added to the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","participant_id","rough","transfer_state","updated_at","polished"],"title":"OutboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"OutboundShipmentDiamondV2Polished":{"description":"Summary of an outbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape","inscription_numbers","report_numbers"],"title":"OutboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundShipmentDiamondV2Rough":{"description":"Summary of an outbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"OutboundShipmentDiamondV2Rough","type":"object"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"}}}}
```

## The OutboundShipmentDiamondV2Polished object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentDiamondV2Polished":{"description":"Summary of an outbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape","inscription_numbers","report_numbers"],"title":"OutboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"}}}}
```

## The OutboundShipmentDiamondV2Rough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentDiamondV2Rough":{"description":"Summary of an outbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"OutboundShipmentDiamondV2Rough","type":"object"}}}}
```

## The OutboundShipmentModel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentModel":{"description":"Details of the outbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/OutboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"receiver":{"title":"Receiver","type":"string"}},"required":["created_at","diamonds","id","name","receiver"],"title":"OutboundShipmentModel","type":"object"},"OutboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"OutboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"}}}}
```

## The OutboundShipmentStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentStatus":{"description":"Derived statuses for outbound shipments.","enum":["accepting","cancelled","cancelling","complete","empty","in_progress","rejected","rejecting","sending","sent"],"title":"OutboundShipmentStatus","type":"string"}}}}
```

## The OutboundShipmentV2 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentV2":{"description":"An outbound shipment containing diamonds that are being transferred from this Tracr instance.\n\nOutbound shipments can be created using the transfer API collection.\nSimilarly the transfer of a diamond within an outbound shipment can be\ncancelled using the transfer API collection.\n\nThis schema is specific to the /v2/shipment collection.","properties":{"created_at":{"description":"The time at which the shipment was created.","format":"date-time","title":"Created At","type":"string"},"diamonds":{"description":"A list of all diamonds contained within this shipment.","items":{"$ref":"#/components/schemas/OutboundShipmentDiamondV2"},"title":"Diamonds","type":"array"},"id":{"description":"The shipment's globally unique identifier.","title":"Id","type":"string"},"name":{"description":"The shipment's name.","title":"Name","type":"string"},"receiver":{"description":"The API URL of the participant to whom this shipment will be sent.","title":"Receiver","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"Whether the shipment contains rough or polished diamonds."},"status":{"$ref":"#/components/schemas/OutboundShipmentStatus","description":"Aggregated status of the diamonds within a shipment."}},"required":["created_at","diamonds","id","name","receiver","shipment_type","status"],"title":"OutboundShipmentV2","type":"object"},"OutboundShipmentDiamondV2":{"description":"A diamond within an outbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which the diamond was added to the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","participant_id","rough","transfer_state","updated_at","polished"],"title":"OutboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"OutboundShipmentDiamondV2Polished":{"description":"Summary of an outbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape","inscription_numbers","report_numbers"],"title":"OutboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundShipmentDiamondV2Rough":{"description":"Summary of an outbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"OutboundShipmentDiamondV2Rough","type":"object"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"},"OutboundShipmentStatus":{"description":"Derived statuses for outbound shipments.","enum":["accepting","cancelled","cancelling","complete","empty","in_progress","rejected","rejecting","sending","sent"],"title":"OutboundShipmentStatus","type":"string"}}}}
```

## The OutboundShipmentV2DetailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentV2DetailResponse":{"description":"A response containing a single outbound shipment.","properties":{"created_at":{"description":"The time at which the shipment was created.","format":"date-time","title":"Created At","type":"string"},"diamonds":{"description":"A list of all diamonds contained within this shipment.","items":{"$ref":"#/components/schemas/OutboundShipmentDiamondV2"},"title":"Diamonds","type":"array"},"id":{"description":"The shipment's globally unique identifier.","title":"Id","type":"string"},"name":{"description":"The shipment's name.","title":"Name","type":"string"},"receiver":{"description":"The API URL of the participant to whom this shipment will be sent.","title":"Receiver","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"Whether the shipment contains rough or polished diamonds."},"status":{"$ref":"#/components/schemas/OutboundShipmentStatus","description":"Aggregated status of the diamonds within a shipment."}},"required":["created_at","diamonds","id","name","receiver","shipment_type","status"],"title":"OutboundShipmentV2DetailResponse","type":"object"},"OutboundShipmentDiamondV2":{"description":"A diamond within an outbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which the diamond was added to the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","participant_id","rough","transfer_state","updated_at","polished"],"title":"OutboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"OutboundShipmentDiamondV2Polished":{"description":"Summary of an outbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape","inscription_numbers","report_numbers"],"title":"OutboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundShipmentDiamondV2Rough":{"description":"Summary of an outbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"OutboundShipmentDiamondV2Rough","type":"object"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"},"OutboundShipmentStatus":{"description":"Derived statuses for outbound shipments.","enum":["accepting","cancelled","cancelling","complete","empty","in_progress","rejected","rejecting","sending","sent"],"title":"OutboundShipmentStatus","type":"string"}}}}
```

## The OutboundShipmentV2FiltersResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentV2FiltersResponse":{"description":"Dynamically populated values for outbound shipment filters.","properties":{"shipment_type":{"items":{"$ref":"#/components/schemas/ShipmentLifecycleState"},"title":"Shipment Type","type":"array"},"status":{"items":{"$ref":"#/components/schemas/OutboundShipmentStatus"},"title":"Status","type":"array"}},"required":["shipment_type","status"],"title":"OutboundShipmentV2FiltersResponse","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"OutboundShipmentStatus":{"description":"Derived statuses for outbound shipments.","enum":["accepting","cancelled","cancelling","complete","empty","in_progress","rejected","rejecting","sending","sent"],"title":"OutboundShipmentStatus","type":"string"}}}}
```

## The OutboundShipmentV2ListResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentV2ListResponse":{"description":"A paginated response containing zero or more outbound shipments.","properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page.","title":"Next"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the current page.","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"The total number of pages.","title":"Pages"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL of the previous page.","title":"Previous"},"results":{"description":"The results for the current page.","items":{"$ref":"#/components/schemas/OutboundShipmentV2"},"title":"Results","type":"array"},"total":{"description":"The total number of results across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"OutboundShipmentV2ListResponse","type":"object"},"OutboundShipmentV2":{"description":"An outbound shipment containing diamonds that are being transferred from this Tracr instance.\n\nOutbound shipments can be created using the transfer API collection.\nSimilarly the transfer of a diamond within an outbound shipment can be\ncancelled using the transfer API collection.\n\nThis schema is specific to the /v2/shipment collection.","properties":{"created_at":{"description":"The time at which the shipment was created.","format":"date-time","title":"Created At","type":"string"},"diamonds":{"description":"A list of all diamonds contained within this shipment.","items":{"$ref":"#/components/schemas/OutboundShipmentDiamondV2"},"title":"Diamonds","type":"array"},"id":{"description":"The shipment's globally unique identifier.","title":"Id","type":"string"},"name":{"description":"The shipment's name.","title":"Name","type":"string"},"receiver":{"description":"The API URL of the participant to whom this shipment will be sent.","title":"Receiver","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"Whether the shipment contains rough or polished diamonds."},"status":{"$ref":"#/components/schemas/OutboundShipmentStatus","description":"Aggregated status of the diamonds within a shipment."}},"required":["created_at","diamonds","id","name","receiver","shipment_type","status"],"title":"OutboundShipmentV2","type":"object"},"OutboundShipmentDiamondV2":{"description":"A diamond within an outbound shipment.\n\nThis schema is specific to the /v2/shipment API collection.","properties":{"created_at":{"description":"The time at which the diamond was added to the shipment.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The diamond's globally unique Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"lifecycle_state":{"$ref":"#/components/schemas/ShipmentLifecycleState","description":"The diamond's lifecycle state. Shipments can only contain diamonds in states rough or polished."},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Polished"},{"type":"null"}],"description":"A summary of the diamond's polished attributes. If the diamond is rough, this field will be null."},"rough":{"anyOf":[{"$ref":"#/components/schemas/OutboundShipmentDiamondV2Rough"},{"type":"null"}],"description":"A summary of the diamond's rough attributes. If the diamond is polished, this field will be null."},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"description":"The last time this diamond was updated. At present, diamonds in a shipment cannot be updated through the API. All changes occur due to automated background processes.","format":"date-time","title":"Updated At","type":"string"}},"required":["created_at","diamond_id","lifecycle_state","participant_id","rough","transfer_state","updated_at","polished"],"title":"OutboundShipmentDiamondV2","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"OutboundShipmentDiamondV2Polished":{"description":"Summary of an outbound diamond's polished attributes.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_numbers":{"items":{"type":"string"},"title":"Report Numbers","type":"array"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape","inscription_numbers","report_numbers"],"title":"OutboundShipmentDiamondV2Polished","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundShipmentDiamondV2Rough":{"description":"Summary of an outbound diamond's rough attributes.","properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"string"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"OutboundShipmentDiamondV2Rough","type":"object"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"},"OutboundShipmentStatus":{"description":"Derived statuses for outbound shipments.","enum":["accepting","cancelled","cancelling","complete","empty","in_progress","rejected","rejecting","sending","sent"],"title":"OutboundShipmentStatus","type":"string"}}}}
```

## The OutboundShipmentsModel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"OutboundShipmentsModel":{"description":"Details of multiple outbound shipments and the diamonds within them.","properties":{"items":{"items":{"$ref":"#/components/schemas/OutboundShipmentModel"},"title":"Items","type":"array"}},"required":["items"],"title":"OutboundShipmentsModel","type":"object"},"OutboundShipmentModel":{"description":"Details of the outbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/OutboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"receiver":{"title":"Receiver","type":"string"}},"required":["created_at","diamonds","id","name","receiver"],"title":"OutboundShipmentModel","type":"object"},"OutboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"OutboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"}}}}
```

## The PermissiveDiamondIDOnly object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"PermissiveDiamondIDOnly":{"description":"An object which contains only a diamond_id field.\n\nWe use a basic str as the type here to bypass pydantic validation\nthat would normally be run for the DiamondID type.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"PermissiveDiamondIDOnly","type":"object"}}}}
```

## The PlanRef object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"}}}}
```

## The PolishDiamond object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"PolishDiamond":{"additionalProperties":false,"properties":{"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.<br/>Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.<br/>Tracr class: entity_specific","nullable":true,"title":"Participant Id"},"participant_timestamp":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"A timestamp (in ISO8601 format) representing the real world time that the change happened.<br/>Tracr class: entity_specific","nullable":true,"title":"Participant Timestamp"},"polished":{"$ref":"#/components/schemas/PolishedSchema"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags<br/>Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["polished"],"title":"PolishDiamond","type":"object"},"PolishedSchema":{"additionalProperties":false,"description":"Data on the polished diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":false,"title":"Carats"},"clarity":{"anyOf":[{"pattern":"^(FL|IF|LC|VVS1|VVS2|VS1|VS2|SI1|SI2|SI3|I1|I2|I3|P1|P2|P3)$","type":"string"},{"type":"null"}],"description":"Clarity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Clarity"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Angle<br/>Tracr class: traceability","nullable":true,"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Height<br/>Tracr class: traceability","nullable":true,"title":"Crown Height"},"culet_condition":{"anyOf":[{"pattern":"^(P|A|C)$","type":"string"},{"type":"null"}],"description":"Culet Condition<br/>Tracr class: traceability","nullable":true,"title":"Culet Condition"},"culet_size":{"anyOf":[{"pattern":"^(EL|VL|L|SL|M|S|VS|N)$","type":"string"},{"type":"null"}],"description":"Culet Size<br/>Tracr class: traceability","nullable":true,"title":"Culet Size"},"cut_grade":{"anyOf":[{"pattern":"^(I|EX|VG|G|F|P|NA)$","type":"string"},{"type":"null"}],"description":"Grade of Cut<br/>Tracr class: traceability","nullable":true,"title":"Cut Grade"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"3rd dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depth percent<br/>Tracr class: traceability","nullable":true,"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Maximum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Minimum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale<br/>Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"girdle_condition":{"anyOf":[{"pattern":"^(P|F|B)$","type":"string"},{"type":"null"}],"description":"Condition of girdle<br/>Tracr class: traceability","nullable":true,"title":"Girdle Condition"},"girdle_thickness_from":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Smallest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness From"},"girdle_thickness_to":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Largest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness To"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"First dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Angle<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Percent<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Quality of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Polish Quality"},"shape":{"$ref":"#/components/schemas/Shape"},"symmetry":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Symmetry of the polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Symmetry"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Table percent<br/>Tracr class: traceability","nullable":true,"title":"Table Percent"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Second dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Width"}},"required":["carats","shape"],"title":"PolishedSchema","type":"object"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"}}}}
```

## The PolishedRW object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"PolishedRW":{"additionalProperties":false,"description":"Data on the polished diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":true,"title":"Carats"},"clarity":{"anyOf":[{"pattern":"^(FL|IF|LC|VVS1|VVS2|VS1|VS2|SI1|SI2|SI3|I1|I2|I3|P1|P2|P3)$","type":"string"},{"type":"null"}],"description":"Clarity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Clarity"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Angle<br/>Tracr class: traceability","nullable":true,"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Height<br/>Tracr class: traceability","nullable":true,"title":"Crown Height"},"culet_condition":{"anyOf":[{"pattern":"^(P|A|C)$","type":"string"},{"type":"null"}],"description":"Culet Condition<br/>Tracr class: traceability","nullable":true,"title":"Culet Condition"},"culet_size":{"anyOf":[{"pattern":"^(EL|VL|L|SL|M|S|VS|N)$","type":"string"},{"type":"null"}],"description":"Culet Size<br/>Tracr class: traceability","nullable":true,"title":"Culet Size"},"cut_grade":{"anyOf":[{"pattern":"^(I|EX|VG|G|F|P|NA)$","type":"string"},{"type":"null"}],"description":"Grade of Cut<br/>Tracr class: traceability","nullable":true,"title":"Cut Grade"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"3rd dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depth percent<br/>Tracr class: traceability","nullable":true,"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Maximum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Minimum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Minimum"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"girdle_condition":{"anyOf":[{"pattern":"^(P|F|B)$","type":"string"},{"type":"null"}],"description":"Condition of girdle<br/>Tracr class: traceability","nullable":true,"title":"Girdle Condition"},"girdle_thickness_from":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Smallest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness From"},"girdle_thickness_to":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Largest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness To"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"First dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Angle<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Percent<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Quality of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Polish Quality"},"shape":{"anyOf":[{"pattern":"(?i)^(Asscher|Baguette|Briolette|Bullets|Calf|Cushion|Emerald|European Cut|Flanders|Half Moon|Heart|Hexagonal|Kite|Lozenge|Marquise|Octagonal|Old Miner|Oval|Pear|Pentagonal|Princess|Radiant|Rectangle|Rose|Round|Shield|Square|Square Emerald|Square Radiant|Star|Tapered Baguette|Tapered Bullet|Trapezoid|Triangle|Trilliant|Cushion Modified Brilliant|Other)$","type":"string"},{"type":"null"}],"description":"Shape of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Shape"},"symmetry":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Symmetry of the polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Symmetry"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Table percent<br/>Tracr class: traceability","nullable":true,"title":"Table Percent"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Second dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Width"}},"title":"PolishedRW","type":"object"}}}}
```

## The PolishedSchema object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"PolishedSchema":{"additionalProperties":false,"description":"Data on the polished diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":false,"title":"Carats"},"clarity":{"anyOf":[{"pattern":"^(FL|IF|LC|VVS1|VVS2|VS1|VS2|SI1|SI2|SI3|I1|I2|I3|P1|P2|P3)$","type":"string"},{"type":"null"}],"description":"Clarity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Clarity"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Angle<br/>Tracr class: traceability","nullable":true,"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Height<br/>Tracr class: traceability","nullable":true,"title":"Crown Height"},"culet_condition":{"anyOf":[{"pattern":"^(P|A|C)$","type":"string"},{"type":"null"}],"description":"Culet Condition<br/>Tracr class: traceability","nullable":true,"title":"Culet Condition"},"culet_size":{"anyOf":[{"pattern":"^(EL|VL|L|SL|M|S|VS|N)$","type":"string"},{"type":"null"}],"description":"Culet Size<br/>Tracr class: traceability","nullable":true,"title":"Culet Size"},"cut_grade":{"anyOf":[{"pattern":"^(I|EX|VG|G|F|P|NA)$","type":"string"},{"type":"null"}],"description":"Grade of Cut<br/>Tracr class: traceability","nullable":true,"title":"Cut Grade"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"3rd dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depth percent<br/>Tracr class: traceability","nullable":true,"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Maximum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Minimum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale<br/>Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"girdle_condition":{"anyOf":[{"pattern":"^(P|F|B)$","type":"string"},{"type":"null"}],"description":"Condition of girdle<br/>Tracr class: traceability","nullable":true,"title":"Girdle Condition"},"girdle_thickness_from":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Smallest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness From"},"girdle_thickness_to":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Largest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness To"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"First dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Angle<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Percent<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Quality of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Polish Quality"},"shape":{"$ref":"#/components/schemas/Shape"},"symmetry":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Symmetry of the polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Symmetry"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Table percent<br/>Tracr class: traceability","nullable":true,"title":"Table Percent"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Second dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Width"}},"required":["carats","shape"],"title":"PolishedSchema","type":"object"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"}}}}
```

## The PossessionState object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"}}}}
```

## The RegisteringIntegrationParty object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"RegisteringIntegrationParty":{"enum":["participant","sarine"],"title":"RegisteringIntegrationParty","type":"string"}}}}
```

## The RegisteringParty object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"RegisteringParty":{"enum":["participant","sarine","diadna"],"title":"RegisteringParty","type":"string"}}}}
```

## The RequestWithTimestamp object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"RequestWithTimestamp":{"additionalProperties":false,"properties":{"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}]},"participant_timestamp":{"description":"The ISO 8601 timestamp of when the real world event occurred","format":"date-time","title":"Participant Timestamp","type":"string"}},"required":["participant_timestamp"],"title":"RequestWithTimestamp","type":"object"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"}}}}
```

## The RoughRW object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"RoughRW":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":true,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.<br/>Tracr class: traceability","nullable":true,"title":"Stress"}},"title":"RoughRW","type":"object"}}}}
```

## The RoughSchema object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"RoughSchema":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":false,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale<br/>Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.<br/>Tracr class: traceability","nullable":true,"title":"Stress"}},"required":["carats"],"title":"RoughSchema","type":"object"}}}}
```

## The ScanFileExtension object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"}}}}
```

## The ScanRef object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"}}}}
```

## The Shape object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"}}}}
```

## The ShipmentLifecycleState object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"}}}}
```

## The SimpleListResponse\_GradingDataView\_ object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"SimpleListResponse_GradingDataView_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/GradingDataView"},"title":"Results","type":"array"}},"required":["results"],"title":"SimpleListResponse[GradingDataView]","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}}
```

## The Symmetry object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"}}}}
```

## The TransferDiamondError object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferDiamondError":{"description":"Returned by transfer endpoints to detail an error with a given diamond.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"status":{"title":"Status","type":"string"}},"required":["diamond_id","diamond_parent_id","status"],"title":"TransferDiamondError","type":"object"}}}}
```

## The TransferErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferErrorResponse":{"description":"Returned by transfer endpoints when an error occurs.","properties":{"diamonds":{"default":[],"items":{"$ref":"#/components/schemas/TransferDiamondError"},"minItems":0,"title":"Diamonds","type":"array"},"message":{"title":"Message","type":"string"}},"required":["message"],"title":"TransferErrorResponse","type":"object"},"TransferDiamondError":{"description":"Returned by transfer endpoints to detail an error with a given diamond.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"status":{"title":"Status","type":"string"}},"required":["diamond_id","diamond_parent_id","status"],"title":"TransferDiamondError","type":"object"}}}}
```

## The TransferInAcceptDiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInAcceptDiamondResult":{"description":"Returned by transfer/in/accept for each diamond accepted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"inscription_number":{"title":"Inscription Number","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptStatus"}},"required":["diamond_id","inscription_number","status"],"title":"TransferInAcceptDiamondResult","type":"object"},"TransferInAcceptStatus":{"description":"Represents the result of a transfer-in-accept operation.","enum":["success","diamond_not_found","inscription_number_invalid","diamond_in_incorrect_state"],"title":"TransferInAcceptStatus","type":"string"}}}}
```

## The TransferInAcceptStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInAcceptStatus":{"description":"Represents the result of a transfer-in-accept operation.","enum":["success","diamond_not_found","inscription_number_invalid","diamond_in_incorrect_state"],"title":"TransferInAcceptStatus","type":"string"}}}}
```

## The TransferInAcceptV2DiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInAcceptV2DiamondResult":{"description":"The result of accepting a transfer for a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptV2Status"}},"required":["diamond_id","status"],"title":"TransferInAcceptV2DiamondResult","type":"object"},"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"}}}}
```

## The TransferInAcceptV2Request object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInAcceptV2Request":{"description":"A list of diamonds to accept for transfer.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"TransferInAcceptV2Request","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"}}}}
```

## The TransferInAcceptV2Response object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInAcceptV2Response":{"description":"Aggregated results of accepting diamonds for transfer.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/TransferInAcceptV2DiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"TransferInAcceptV2Response","type":"object"},"TransferInAcceptV2DiamondResult":{"description":"The result of accepting a transfer for a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptV2Status"}},"required":["diamond_id","status"],"title":"TransferInAcceptV2DiamondResult","type":"object"},"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"}}}}
```

## The TransferInAcceptV2Status object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"}}}}
```

## The TransferInRejectDiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInRejectDiamondResult":{"description":"Returned by transfer/in/reject for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInRejectStatus"}},"required":["diamond_id","status"],"title":"TransferInRejectDiamondResult","type":"object"},"TransferInRejectStatus":{"description":"Represents the result of a transfer-in-reject operation.","enum":["success","diamond_in_incorrect_state","diamond_transfer_cancelled","diamond_transfer_complete","diamond_not_found"],"title":"TransferInRejectStatus","type":"string"}}}}
```

## The TransferInRejectStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferInRejectStatus":{"description":"Represents the result of a transfer-in-reject operation.","enum":["success","diamond_in_incorrect_state","diamond_transfer_cancelled","diamond_transfer_complete","diamond_not_found"],"title":"TransferInRejectStatus","type":"string"}}}}
```

## The TransferOutCancelDiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutCancelDiamondResult":{"description":"Returned by transfer/out/cancel for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferOutCancelStatus"}},"required":["diamond_id","status"],"title":"TransferOutCancelDiamondResult","type":"object"},"TransferOutCancelStatus":{"description":"Represents the result of a transfer-out-cancel operation.","enum":["success","diamond_transfer_complete","diamond_transfer_rejected","diamond_not_found"],"title":"TransferOutCancelStatus","type":"string"}}}}
```

## The TransferOutCancelStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutCancelStatus":{"description":"Represents the result of a transfer-out-cancel operation.","enum":["success","diamond_transfer_complete","diamond_transfer_rejected","diamond_not_found"],"title":"TransferOutCancelStatus","type":"string"}}}}
```

## The TransferOutStartDiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutStartDiamondResult":{"description":"Returned by the V1 transfer/out/start endpoint for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","status"],"title":"TransferOutStartDiamondResult","type":"object"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"}}}}
```

## The TransferOutStartRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutStartRequest":{"description":"A request to start a transfer out for a sequence of diamonds to the V1\ntransfer/out/start endpoint.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"},"receiver":{"pattern":"^https://api\\..+\\.tracr\\.com$","title":"Receiver","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_name","receiver","diamonds"],"title":"TransferOutStartRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"}}}}
```

## The TransferOutStartResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutStartResponse":{"description":"A response to a V1 transfer/out/start request.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/TransferOutStartDiamondResult"},"title":"Diamonds","type":"array"},"shipment_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_id","shipment_name","diamonds"],"title":"TransferOutStartResponse","type":"object"},"TransferOutStartDiamondResult":{"description":"Returned by the V1 transfer/out/start endpoint for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","status"],"title":"TransferOutStartDiamondResult","type":"object"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"}}}}
```

## The TransferOutValidateMissing object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutValidateMissing":{"description":"Returned by the validate_diamonds_for_transfer function for a diamond that\ndoes not exist.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"status":{"const":"diamond_does_not_exist","default":"diamond_does_not_exist","title":"Status","type":"string"}},"required":["diamond_id"],"title":"TransferOutValidateMissing","type":"object"}}}}
```

## The TransferOutValidatePolishedStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"}}}}
```

## The TransferOutValidateRoughStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"TransferOutValidateRoughStatus":{"description":"Represents the status of a transfer out validation request for a rough\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_cannot_have_parent","diamond_missing_rough_scan","diamond_missing_rough_check"],"title":"TransferOutValidateRoughStatus","type":"string"}}}}
```

## The UnarchiveDiamondResult object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UnarchiveDiamondResult":{"description":"The result of un-archiving a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/UnarchiveStatus"}},"required":["diamond_id","status"],"title":"UnarchiveDiamondResult","type":"object"},"UnarchiveStatus":{"description":"Indicates that a diamond was successfully un-archived or the reason why\nthe diamond could not be un-archived.","enum":["success","diamond_not_found"],"title":"UnarchiveStatus","type":"string"}}}}
```

## The UnarchiveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UnarchiveRequest":{"description":"A list of diamonds to un-archive.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"UnarchiveRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"}}}}
```

## The UnarchiveResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UnarchiveResponse":{"description":"Aggregated results of un-archiving diamonds.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/UnarchiveDiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"UnarchiveResponse","type":"object"},"UnarchiveDiamondResult":{"description":"The result of un-archiving a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/UnarchiveStatus"}},"required":["diamond_id","status"],"title":"UnarchiveDiamondResult","type":"object"},"UnarchiveStatus":{"description":"Indicates that a diamond was successfully un-archived or the reason why\nthe diamond could not be un-archived.","enum":["success","diamond_not_found"],"title":"UnarchiveStatus","type":"string"}}}}
```

## The UnarchiveStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UnarchiveStatus":{"description":"Indicates that a diamond was successfully un-archived or the reason why\nthe diamond could not be un-archived.","enum":["success","diamond_not_found"],"title":"UnarchiveStatus","type":"string"}}}}
```

## The UnlockRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UnlockRequest":{"description":"Represents a request to unlock one or more locked diamonds.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"UnlockRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"}}}}
```

## The UnlockResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UnlockResponse":{"description":"Represents the response to an UnlockRequest.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DiamondUnlockResult"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"UnlockResponse","type":"object"},"DiamondUnlockResult":{"description":"Represents the result of an attempt to unlock a single diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondUnlockResultStatus"}},"required":["diamond_id","status"],"title":"DiamondUnlockResult","type":"object"},"DiamondUnlockResultStatus":{"description":"Represents the possible responses to an attempt to unlock a diamond.","enum":["diamond_does_not_exist","diamond_cannot_be_unlocked","missing_unlock_requirement","success"],"title":"DiamondUnlockResultStatus","type":"string"}}}}
```

## The UpdatePolished object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UpdatePolished":{"additionalProperties":false,"properties":{"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.<br/>Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"pattern":"^\\S(.*\\S)?$","type":"string"},{"type":"null"}],"description":"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 <code>possession_state</code> is <code>held</code>.","title":"Participant Id"},"participant_timestamp":{"format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/PolishedRW","default":{}},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags<br/>Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_timestamp"],"title":"UpdatePolished","type":"object"},"PolishedRW":{"additionalProperties":false,"description":"Data on the polished diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":true,"title":"Carats"},"clarity":{"anyOf":[{"pattern":"^(FL|IF|LC|VVS1|VVS2|VS1|VS2|SI1|SI2|SI3|I1|I2|I3|P1|P2|P3)$","type":"string"},{"type":"null"}],"description":"Clarity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Clarity"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Angle<br/>Tracr class: traceability","nullable":true,"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Height<br/>Tracr class: traceability","nullable":true,"title":"Crown Height"},"culet_condition":{"anyOf":[{"pattern":"^(P|A|C)$","type":"string"},{"type":"null"}],"description":"Culet Condition<br/>Tracr class: traceability","nullable":true,"title":"Culet Condition"},"culet_size":{"anyOf":[{"pattern":"^(EL|VL|L|SL|M|S|VS|N)$","type":"string"},{"type":"null"}],"description":"Culet Size<br/>Tracr class: traceability","nullable":true,"title":"Culet Size"},"cut_grade":{"anyOf":[{"pattern":"^(I|EX|VG|G|F|P|NA)$","type":"string"},{"type":"null"}],"description":"Grade of Cut<br/>Tracr class: traceability","nullable":true,"title":"Cut Grade"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"3rd dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depth percent<br/>Tracr class: traceability","nullable":true,"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Maximum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Minimum<br/>Tracr class: traceability","nullable":true,"title":"Diameter Minimum"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"girdle_condition":{"anyOf":[{"pattern":"^(P|F|B)$","type":"string"},{"type":"null"}],"description":"Condition of girdle<br/>Tracr class: traceability","nullable":true,"title":"Girdle Condition"},"girdle_thickness_from":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Smallest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness From"},"girdle_thickness_to":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Largest girdle thickness category<br/>Tracr class: traceability","nullable":true,"title":"Girdle Thickness To"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"First dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Angle<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Percent<br/>Tracr class: traceability","nullable":true,"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Quality of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Polish Quality"},"shape":{"anyOf":[{"pattern":"(?i)^(Asscher|Baguette|Briolette|Bullets|Calf|Cushion|Emerald|European Cut|Flanders|Half Moon|Heart|Hexagonal|Kite|Lozenge|Marquise|Octagonal|Old Miner|Oval|Pear|Pentagonal|Princess|Radiant|Rectangle|Rose|Round|Shield|Square|Square Emerald|Square Radiant|Star|Tapered Baguette|Tapered Bullet|Trapezoid|Triangle|Trilliant|Cushion Modified Brilliant|Other)$","type":"string"},{"type":"null"}],"description":"Shape of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Shape"},"symmetry":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Symmetry of the polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Symmetry"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Table percent<br/>Tracr class: traceability","nullable":true,"title":"Table Percent"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Second dimension of polished diamond<br/>Tracr class: traceability","nullable":true,"title":"Width"}},"title":"PolishedRW","type":"object"}}}}
```

## The UpdateRough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UpdateRough":{"additionalProperties":false,"properties":{"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Box description<br/>Tracr class: entity_specific","nullable":true,"title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"System name and ID pairs identifying the source batch for the diamond.<br/>Tracr class: entity_specific","nullable":true,"title":"Box Id"},"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.<br/>Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"pattern":"^\\S(.*\\S)?$","type":"string"},{"type":"null"}],"description":"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 <code>possession_state</code> is <code>held</code>.","title":"Participant Id"},"participant_timestamp":{"format":"date-time","title":"Participant Timestamp","type":"string"},"rough":{"$ref":"#/components/schemas/RoughRW","default":{}},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight number<br/>Tracr class: entity_specific","nullable":true,"title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight year<br/>Tracr class: entity_specific","nullable":true,"title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags<br/>Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_timestamp"],"title":"UpdateRough","type":"object"},"RoughRW":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":true,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.<br/>Tracr class: traceability","nullable":true,"title":"Stress"}},"title":"RoughRW","type":"object"}}}}
```

## The UpdateRoughV2 object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"UpdateRoughV2":{"additionalProperties":false,"properties":{"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Box description<br/>Tracr class: entity_specific","nullable":true,"title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"System name and ID pairs identifying the source batch for the diamond.<br/>Tracr class: entity_specific","nullable":true,"title":"Box Id"},"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.<br/>Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"pattern":"^\\S(.*\\S)?$","type":"string"},{"type":"null"}],"description":"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 <code>possession_state</code> is <code>held</code>.","title":"Participant Id"},"participant_timestamp":{"format":"date-time","title":"Participant Timestamp","type":"string"},"provenance":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Provenance"},"rough":{"$ref":"#/components/schemas/RoughRW","default":{}},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight number<br/>Tracr class: entity_specific","nullable":true,"title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight year<br/>Tracr class: entity_specific","nullable":true,"title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags<br/>Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_timestamp"],"title":"UpdateRoughV2","type":"object"},"RoughRW":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats<br/>Tracr class: traceability","nullable":true,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour<br/>Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond<br/>Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<br/>Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.<br/>Tracr class: traceability","nullable":true,"title":"Stress"}},"title":"RoughRW","type":"object"}}}}
```

## The V2TransferOutPolishedFields object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutPolishedFields":{"properties":{"carats":{"title":"Carats","type":"number"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape"],"title":"V2TransferOutPolishedFields","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"}}}}
```

## The V2TransferOutRoughFields object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutRoughFields":{"properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"number"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"V2TransferOutRoughFields","type":"object"}}}}
```

## The V2TransferOutStartErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutStartErrorResponse":{"description":"Returns a list of all diamonds requested in the v2 /transfer/out/start\nendpoint and their corresponding statuses.","properties":{"diamonds":{"items":{"anyOf":[{"$ref":"#/components/schemas/TransferOutValidateMissing"},{"$ref":"#/components/schemas/V2TransferOutValidatePolished"},{"$ref":"#/components/schemas/V2TransferOutValidateRough"}]},"title":"Diamonds","type":"array"},"message":{"title":"Message","type":"string"},"status":{"$ref":"#/components/schemas/V2TransferOutValidateStatus"}},"required":["diamonds","status","message"],"title":"V2TransferOutStartErrorResponse","type":"object"},"TransferOutValidateMissing":{"description":"Returned by the validate_diamonds_for_transfer function for a diamond that\ndoes not exist.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"status":{"const":"diamond_does_not_exist","default":"diamond_does_not_exist","title":"Status","type":"string"}},"required":["diamond_id"],"title":"TransferOutValidateMissing","type":"object"},"V2TransferOutValidatePolished":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"polished","default":"polished","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"$ref":"#/components/schemas/V2TransferOutPolishedFields"},"rough":{"title":"Rough","type":"null"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidatePolished","type":"object"},"V2TransferOutPolishedFields":{"properties":{"carats":{"title":"Carats","type":"number"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape"],"title":"V2TransferOutPolishedFields","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"},"V2TransferOutValidateRough":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"rough","default":"rough","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"title":"Polished","type":"null"},"rough":{"$ref":"#/components/schemas/V2TransferOutRoughFields"},"status":{"$ref":"#/components/schemas/TransferOutValidateRoughStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidateRough","type":"object"},"V2TransferOutRoughFields":{"properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"number"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"V2TransferOutRoughFields","type":"object"},"TransferOutValidateRoughStatus":{"description":"Represents the status of a transfer out validation request for a rough\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_cannot_have_parent","diamond_missing_rough_scan","diamond_missing_rough_check"],"title":"TransferOutValidateRoughStatus","type":"string"},"V2TransferOutValidateStatus":{"enum":["invalid","validated"],"title":"V2TransferOutValidateStatus","type":"string"}}}}
```

## The V2TransferOutStartRequest object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutStartRequest":{"description":"V2 of TransferOutStartRequest model, with shipment_type","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/PermissiveDiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"},"receiver":{"pattern":"^https://api\\..+\\.tracr\\.com$","title":"Receiver","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState"}},"required":["shipment_name","receiver","shipment_type","diamonds"],"title":"V2TransferOutStartRequest","type":"object"},"PermissiveDiamondIDOnly":{"description":"An object which contains only a diamond_id field.\n\nWe use a basic str as the type here to bypass pydantic validation\nthat would normally be run for the DiamondID type.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"PermissiveDiamondIDOnly","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"}}}}
```

## The V2TransferOutStartResponse object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutStartResponse":{"description":"A response to a V2 transfer/out/start request.","properties":{"diamonds":{"items":{"anyOf":[{"$ref":"#/components/schemas/TransferOutValidateMissing"},{"$ref":"#/components/schemas/V2TransferOutValidatePolished"},{"$ref":"#/components/schemas/V2TransferOutValidateRough"}]},"title":"Diamonds","type":"array"},"shipment_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_id","shipment_name","diamonds"],"title":"V2TransferOutStartResponse","type":"object"},"TransferOutValidateMissing":{"description":"Returned by the validate_diamonds_for_transfer function for a diamond that\ndoes not exist.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"status":{"const":"diamond_does_not_exist","default":"diamond_does_not_exist","title":"Status","type":"string"}},"required":["diamond_id"],"title":"TransferOutValidateMissing","type":"object"},"V2TransferOutValidatePolished":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"polished","default":"polished","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"$ref":"#/components/schemas/V2TransferOutPolishedFields"},"rough":{"title":"Rough","type":"null"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidatePolished","type":"object"},"V2TransferOutPolishedFields":{"properties":{"carats":{"title":"Carats","type":"number"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape"],"title":"V2TransferOutPolishedFields","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"},"V2TransferOutValidateRough":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"rough","default":"rough","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"title":"Polished","type":"null"},"rough":{"$ref":"#/components/schemas/V2TransferOutRoughFields"},"status":{"$ref":"#/components/schemas/TransferOutValidateRoughStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidateRough","type":"object"},"V2TransferOutRoughFields":{"properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"number"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"V2TransferOutRoughFields","type":"object"},"TransferOutValidateRoughStatus":{"description":"Represents the status of a transfer out validation request for a rough\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_cannot_have_parent","diamond_missing_rough_scan","diamond_missing_rough_check"],"title":"TransferOutValidateRoughStatus","type":"string"}}}}
```

## The V2TransferOutValidatePolished object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutValidatePolished":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"polished","default":"polished","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"$ref":"#/components/schemas/V2TransferOutPolishedFields"},"rough":{"title":"Rough","type":"null"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidatePolished","type":"object"},"V2TransferOutPolishedFields":{"properties":{"carats":{"title":"Carats","type":"number"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape"],"title":"V2TransferOutPolishedFields","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"}}}}
```

## The V2TransferOutValidateRough object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutValidateRough":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"rough","default":"rough","title":"Lifecycle State","type":"string"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","title":"Participant Id"},"polished":{"title":"Polished","type":"null"},"rough":{"$ref":"#/components/schemas/V2TransferOutRoughFields"},"status":{"$ref":"#/components/schemas/TransferOutValidateRoughStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidateRough","type":"object"},"V2TransferOutRoughFields":{"properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"number"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"V2TransferOutRoughFields","type":"object"},"TransferOutValidateRoughStatus":{"description":"Represents the status of a transfer out validation request for a rough\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_cannot_have_parent","diamond_missing_rough_scan","diamond_missing_rough_check"],"title":"TransferOutValidateRoughStatus","type":"string"}}}}
```

## The V2TransferOutValidateStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"V2TransferOutValidateStatus":{"enum":["invalid","validated"],"title":"V2TransferOutValidateStatus","type":"string"}}}}
```

## The ValidationError object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## The ValidationLevel object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}}
```

## The VerificationStatus object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}}
```

## The VideoFileExtension object

```json
{"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"components":{"schemas":{"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tracr.com/api-reference/tracr-api/references/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.