> 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/references/tracr-xps-api-v1.md).

# Tracr XPS API V1

## Get Traceability Ancestry

> Get traceability ancestry for multiple diamonds from many peers.

```json
{"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"TraceabilityAncestryRequest":{"description":"Represents a request to the /diamonds/traceability-ancestry endpoint.","properties":{"data":{"items":{"$ref":"#/components/schemas/TraceabilityAncestryParticipantFilter"},"title":"Data","type":"array"}},"required":["data"],"title":"TraceabilityAncestryRequest","type":"object"},"TraceabilityAncestryParticipantFilter":{"description":"Participant level filters for traceability ancestry requests.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/TraceabilityAncestryFilterDiamond"},"title":"Diamonds","type":"array"},"modified_since":{"anyOf":[{"description":"An ISO 8601 compliant timestamp.","format":"date-time","type":"string"},{"type":"null"}],"title":"Modified Since"},"platform_id":{"format":"uuid","title":"Platform Id","type":"string"}},"required":["diamonds","platform_id"],"title":"TraceabilityAncestryParticipantFilter","type":"object"},"TraceabilityAncestryFilterDiamond":{"description":"Diamond level filters for traceability ancestry requests.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"TraceabilityAncestryFilterDiamond","type":"object"},"TypedTraceabilityAncestryResponse":{"description":"Represents a response from the /diamonds/traceability-ancestry endpoint.","properties":{"results":{"items":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityAncestryResultSuccess"},{"$ref":"#/components/schemas/TraceabilityAncestryResultError"}]},"title":"Results","type":"array"}},"required":["results"],"title":"TypedTraceabilityAncestryResponse","type":"object"},"TraceabilityAncestryResultSuccess":{"description":"A successful traceability ancestry result containing diamonds with ancestry.","properties":{"diamonds":{"patternProperties":{"^[a-z\\d]{20,98}$":{"items":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"},"type":"array"}},"propertyNames":{},"title":"Diamonds","type":"object"},"platform_id":{"format":"uuid","title":"Platform Id","type":"string"},"status":{"$ref":"#/components/schemas/TraceabilityAncestryResultStatus"}},"required":["status","platform_id","diamonds"],"title":"TraceabilityAncestryResultSuccess","type":"object"},"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"items":{"anyOf":[{"$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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"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"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"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":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"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":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"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"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"},"TraceabilityAncestryResultStatus":{"description":"Per participant statuses for results from the traceability ancestry endpoint.","enum":["success","not_found","unauthorised","unknown_error"],"title":"TraceabilityAncestryResultStatus","type":"string"},"TraceabilityAncestryResultError":{"description":"An unsuccessful traceability ancestry result with an error message.","properties":{"error":{"title":"Error","type":"string"},"platform_id":{"format":"uuid","title":"Platform Id","type":"string"},"status":{"$ref":"#/components/schemas/TraceabilityAncestryResultStatus"}},"required":["status","platform_id","error"],"title":"TraceabilityAncestryResultError","type":"object"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"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"}}},"paths":{"/v1/bulk/traceability-ancestry":{"post":{"description":"Get traceability ancestry for multiple diamonds from many peers.","operationId":"get_traceability_ancestry_v1_bulk_traceability_ancestry_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceabilityAncestryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypedTraceabilityAncestryResponse"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Traceability Ancestry","tags":["Tracr XPS API v1","Bulk Diamond Search"]}}}}
```

## Get Diamonds

> Search for diamonds matching the given query.

```json
{"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"OptionalAuth0JWTAuth":[]}],"components":{"securitySchemes":{"OptionalAuth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"Paginator_CrossIdDiamondSearchResult_":{"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/CrossIdDiamondSearchResult"},"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":"Paginator[CrossIdDiamondSearchResult]","type":"object"},"CrossIdDiamondSearchResult":{"description":"Represents a single diamond in the database, as returned by a cross-id-search.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"description":"The identifier by which this diamond was retrieved.","enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"locked_diamond":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Locked Diamond"}},"required":["identity_type","diamond"],"title":"CrossIdDiamondSearchResult","type":"object"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"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"}}},"paths":{"/v1/diamonds/":{"get":{"description":"Search for diamonds matching the given query.","operationId":"get_diamonds_v1_diamonds__get","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Page number","minimum":1,"title":"Page","type":"integer"}},{"in":"query","name":"size","required":false,"schema":{"default":100,"maximum":1000,"minimum":1,"title":"Size","type":"integer"}},{"in":"query","name":"search","required":true,"schema":{"title":"Search","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginator_CrossIdDiamondSearchResult_"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamonds","tags":["Tracr XPS API v1","Diamond Search"]}}}}
```

## Get Diamond

> Look up a single diamond in Tracr and return its data if it exists.

```json
{"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"OptionalAuth0JWTAuth":[]}],"components":{"securitySchemes":{"OptionalAuth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"items":{"anyOf":[{"$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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"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"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"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":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"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":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"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"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"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"}}},"paths":{"/v1/diamonds/{diamond_id}":{"get":{"description":"Look up a single diamond in Tracr and return its data if it exists.","operationId":"get_diamond_v1_diamonds__diamond_id__get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamond","tags":["Tracr XPS API v1","Diamond Search"]}}}}
```

## Get Diamond File

> Fetch a single file's pre-signed URL and return a Response.

```json
{"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"OptionalAuth0JWTAuth":[]}],"components":{"securitySchemes":{"OptionalAuth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"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"}}},"paths":{"/v1/diamonds/{diamond_id}/files/{file_hash}":{"get":{"description":"Fetch a single file's pre-signed URL and return a Response.","operationId":"get_diamond_file_v1_diamonds__diamond_id__files__file_hash__get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},{"in":"path","name":"file_hash","required":true,"schema":{"title":"File Hash","type":"string"}}],"responses":{"302":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond or file not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"The file was found in the Tracr network but a pre-signed URL could not be generated."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"An unexpected response was received from the participant's API."}},"summary":"Get Diamond File","tags":["Tracr XPS API v1"]}}}}
```

## Get Diamond History

> Look up a single diamond in Tracr and return its history.

```json
{"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"OptionalAuth0JWTAuth":[]}],"components":{"securitySchemes":{"OptionalAuth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"TraceabilityHistoryReadView":{"description":"A version of FullReadView containing only traceability data.","properties":{"content":{"additionalProperties":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"},"title":"Content","type":"object"}},"required":["content"],"title":"TraceabilityHistoryReadView","type":"object"},"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"items":{"anyOf":[{"$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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"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"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"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":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"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":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"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"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"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"}}},"paths":{"/v1/diamonds/{diamond_id}/history":{"get":{"description":"Look up a single diamond in Tracr and return its history.","operationId":"get_diamond_history_v1_diamonds__diamond_id__history_get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceabilityHistoryReadView"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamond History","tags":["Tracr XPS API v1","Diamond Search"]}}}}
```


---

# 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/references/tracr-xps-api-v1.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.