> 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/grading-integration-service-gis-api/references/api-v1.md).

# API V1

## Get Diamond

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

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}":{"get":{"deprecated":true,"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/tracr__gis__api__v1__models__SimplifiedDiamond"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when a Diamond is not found in the Tracr network."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Get Diamond","tags":["API v1","Deprecated","Diamond Verification","Verify 1"]}}},"components":{"schemas":{"tracr__gis__api__v1__models__SimplifiedDiamond":{"description":"A simplified set of data about a Tracr-registered diamond.","properties":{"assets":{"default":[],"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"},"carats":{"description":"The weight of the diamond in carats","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d{0,3}0*$","title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Clarity of the diamond"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Colour of the diamond"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"The fancy colour of the diamond."},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provenance name of the diamond.","title":"Provenance"},"shape":{"$ref":"#/components/schemas/Shape","description":"Shape of polished diamond."}},"required":["diamond_id","shape","carats"],"title":"SimplifiedDiamond","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"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","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"}}}}
```

## Upload Diamond Grading Certificate

> Add a grading certificate to a diamond in Tracr.\
> \
> Accepts a multipart/form-data request.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/certificate":{"post":{"deprecated":true,"description":"Add a grading certificate to a diamond in Tracr.\n\nAccepts a multipart/form-data request.","operationId":"upload_diamond_grading_certificate_v1_diamonds__diamond_id__certificate_post","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/tracr__gis__api__v1__peers__GradingCertificateParameters"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when a Diamond is not found in the Tracr network."},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when `certificate_file` is not an application/pdf file."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when a given grading cert. has already been uploaded for a given diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Upload Diamond Grading Certificate","tags":["API v1","Deprecated","Diamond Update"]}}},"components":{"schemas":{"tracr__gis__api__v1__peers__GradingCertificateParameters":{"properties":{"certificate_file":{"description":"The certificate file. Must be an application/pdf file, otherwise the upload will be rejected.","format":"binary","title":"Certificate File","type":"string"},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The graded date of the diamond as an ISO 8601 string","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grader certificate number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grader inscription number","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grader report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"exclude":true,"title":"Grading Lab"}},"required":["certificate_file"],"title":"GradingCertificateParameters","type":"object"},"FileUploadResponse":{"description":"Sent when an inscription number or certificate has been added to a diamond.","properties":{"hash":{"description":"The hash of the uploaded inscription number data.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","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"}}}}
```

## Add Diamond Inscription Number

> Add an inscription number to a diamond in Tracr.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/inscription-number":{"post":{"deprecated":true,"description":"Add an inscription number to a diamond in Tracr.","operationId":"add_diamond_inscription_number_v1_diamonds__diamond_id__inscription_number_post","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tracr__gis__api__v1__models__AddInscriptionNumberRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when a Diamond is not found in the Tracr network."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when a given inscription number has already been uploaded for a given diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Add Diamond Inscription Number","tags":["API v1","Deprecated","Diamond Update"]}}},"components":{"schemas":{"tracr__gis__api__v1__models__AddInscriptionNumberRequest":{"additionalProperties":false,"description":"The data required to add an inscription number to a diamond.","properties":{"inscription_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Inscription Date"},"inscription_grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inscription Grading Lab"},"inscription_number":{"description":"The inscription number to add to the diamond. Must have a non-zero length.","minLength":1,"title":"Inscription Number","type":"string"}},"required":["inscription_number"],"title":"AddInscriptionNumberRequest","type":"object"},"FileUploadResponse":{"description":"Sent when an inscription number or certificate has been added to a diamond.","properties":{"hash":{"description":"The hash of the uploaded inscription number data.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","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"}}}}
```

## Validate Diamond

> Validate that a set of diamond data matches that stored in Tracr.\
> \
> This endpoint uploads the sarine scan file to the diamond's Tracr instance,\
> then notifies the DiamondID service that it needs to perform an\
> identify-polished operation on the diamond.\
> \
> The success or failure of this operation can be determined by GETing\
> /diamonds/{diamond\_id}/validate/status.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/validate":{"post":{"deprecated":true,"description":"Validate that a set of diamond data matches that stored in Tracr.\n\nThis endpoint uploads the sarine scan file to the diamond's Tracr instance,\nthen notifies the DiamondID service that it needs to perform an\nidentify-polished operation on the diamond.\n\nThe success or failure of this operation can be determined by GETing\n/diamonds/{diamond_id}/validate/status.","operationId":"validate_diamond_v1_diamonds__diamond_id__validate_post","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_validate_diamond_v1_diamonds__diamond_id__validate_post"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationRequestResponse"}}},"description":"Returned when a validation request is accepted for processing."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when a Diamond is not found in the Tracr network."},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when the sarine_scan file is not valid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Validate Diamond","tags":["API v1","Deprecated","Diamond Validation","Verify 2"]}}},"components":{"schemas":{"Body_validate_diamond_v1_diamonds__diamond_id__validate_post":{"properties":{"sarine_scan":{"format":"binary","title":"Sarine Scan","type":"string"}},"required":["sarine_scan"],"title":"Body_validate_diamond_v1_diamonds__diamond_id__validate_post","type":"object"},"ValidationRequestResponse":{"description":"A response to a request for the validation of a diamond.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation has been requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"request_id":{"description":"The unique ID for this validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"status_url":{"description":"The URL from which to fetch the status of this validation request via an HTTP GET","title":"Status Url","type":"string"},"verification_status":{"default":"Pending","description":"The current status of the verification request","title":"Verification Status","type":"string"}},"required":["diamond_id","request_id","status_url"],"title":"ValidationRequestResponse","type":"object"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","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"}}}}
```

## Get Answered Responses

> Return all answered or errored validation requests for a diamond.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/validate/answered":{"get":{"deprecated":true,"description":"Return all answered or errored validation requests for a diamond.","operationId":"get_answered_responses_v1_diamonds__diamond_id__validate_answered_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":{"items":{"$ref":"#/components/schemas/ValidationFeedback"},"title":"Response Get Answered Responses V1 Diamonds  Diamond Id  Validate Answered Get","type":"array"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when no validation request has been made for a given diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Get Answered Responses","tags":["API v1","Deprecated","Diamond Validation"]}}},"components":{"schemas":{"ValidationFeedback":{"description":"The full feedback on a validation operation, as returned by GIS.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation was requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"request_id":{"description":"The unique ID of the validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"requested_at":{"description":"The UTC datetime at which the validation request was created.","format":"date-time","title":"Requested At","type":"string"},"verification_description":{"description":"A message from DiamondID describing the validation status.","title":"Verification Description","type":"string"},"verification_error":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ValidationError"},"type":"object"},{"type":"null"}],"description":"Errors from validation, as a map of <field_name>: [<validation error>].","title":"Verification Error"},"verification_status":{"$ref":"#/components/schemas/ValidationAnswer","description":"The validation status returned by DiamondID."}},"required":["diamond_id","request_id","requested_at","verification_status","verification_description"],"title":"ValidationFeedback","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"},"ValidationAnswer":{"description":"Represents an answer from Diamond ID or GIS to validation request.\n\n- Pending: the validation request is pending (yet to processed by Diamond\n  ID or GIS)\n- Verified: The request has been successfully processed, and the diamond\n  verified.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Error","Invalid","Pending","Unverifiable","Verified"],"title":"ValidationAnswer","type":"string"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}}}
```

## Get Historic Validation Requests For Diamond

> Return all answered or errored validation requests for a diamond.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/validate/historic":{"get":{"deprecated":true,"description":"Return all answered or errored validation requests for a diamond.","operationId":"get_historic_validation_requests_for_diamond_v1_diamonds__diamond_id__validate_historic_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":{"items":{"$ref":"#/components/schemas/HistoricalValidationFeedback"},"title":"Response Get Historic Validation Requests For Diamond V1 Diamonds  Diamond Id  Validate Historic Get","type":"array"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when no validation request has been made for a given diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Get Historic Validation Requests For Diamond","tags":["API v1","Deprecated","Diamond Validation"]}}},"components":{"schemas":{"HistoricalValidationFeedback":{"description":"A ValidationFeedback object used for reporting historic data.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation was requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"expired":{"description":"True if DiamondID did not respond to the request in a timely fashion.","title":"Expired","type":"boolean"},"request_id":{"description":"The unique ID of the validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"requested_at":{"description":"The UTC datetime at which the validation request was created.","format":"date-time","title":"Requested At","type":"string"},"verification_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A message from DiamondID describing the validation status.","title":"Verification Description"},"verification_error":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ValidationError"},"type":"object"},{"type":"null"}],"description":"Errors from validation.","title":"Verification Error"},"verification_status":{"$ref":"#/components/schemas/ValidationAnswer","default":"Pending","description":"The validation status returned by DiamondID."}},"required":["diamond_id","request_id","requested_at","expired"],"title":"HistoricalValidationFeedback","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"},"ValidationAnswer":{"description":"Represents an answer from Diamond ID or GIS to validation request.\n\n- Pending: the validation request is pending (yet to processed by Diamond\n  ID or GIS)\n- Verified: The request has been successfully processed, and the diamond\n  verified.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Error","Invalid","Pending","Unverifiable","Verified"],"title":"ValidationAnswer","type":"string"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}}}
```

## Get Latest Request Status

> Return the latest non-expired validation request for a diamond.\
> \
> This endpoint is deprecated, as it does not return a full picture of the\
> diamond's validation history.\
> \
> Instead, use \`/v1/diamonds/{diamond\_id}/validate/{request\_id}\` to fetch the\
> status of a specific request, or\
> \`/v1/diamonds/{diamond\_id}/validate/answered\` to fetch the status of all\
> requests answered by DiamondID.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/validate/status":{"get":{"deprecated":true,"description":"Return the latest non-expired validation request for a diamond.\n\nThis endpoint is deprecated, as it does not return a full picture of the\ndiamond's validation history.\n\nInstead, use `/v1/diamonds/{diamond_id}/validate/{request_id}` to fetch the\nstatus of a specific request, or\n`/v1/diamonds/{diamond_id}/validate/answered` to fetch the status of all\nrequests answered by DiamondID.","operationId":"get_latest_request_status_v1_diamonds__diamond_id__validate_status_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/ValidationFeedback"}}},"description":"Returned when a validation request has been answered by the DiamondID service."},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationRequestResponse"}}},"description":"Returned when a validation request has been made, but has not yet been answered by DiamondID."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":["Returned when neither the diamond, or any validation request for it, is not found."]},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":["Returned when the latest validation request has expired without a response from the DiamondID service."]},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Get Latest Request Status","tags":["API v1","Deprecated","Diamond Validation"]}}},"components":{"schemas":{"ValidationFeedback":{"description":"The full feedback on a validation operation, as returned by GIS.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation was requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"request_id":{"description":"The unique ID of the validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"requested_at":{"description":"The UTC datetime at which the validation request was created.","format":"date-time","title":"Requested At","type":"string"},"verification_description":{"description":"A message from DiamondID describing the validation status.","title":"Verification Description","type":"string"},"verification_error":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ValidationError"},"type":"object"},{"type":"null"}],"description":"Errors from validation, as a map of <field_name>: [<validation error>].","title":"Verification Error"},"verification_status":{"$ref":"#/components/schemas/ValidationAnswer","description":"The validation status returned by DiamondID."}},"required":["diamond_id","request_id","requested_at","verification_status","verification_description"],"title":"ValidationFeedback","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"},"ValidationAnswer":{"description":"Represents an answer from Diamond ID or GIS to validation request.\n\n- Pending: the validation request is pending (yet to processed by Diamond\n  ID or GIS)\n- Verified: The request has been successfully processed, and the diamond\n  verified.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Error","Invalid","Pending","Unverifiable","Verified"],"title":"ValidationAnswer","type":"string"},"ValidationRequestResponse":{"description":"A response to a request for the validation of a diamond.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation has been requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"request_id":{"description":"The unique ID for this validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"status_url":{"description":"The URL from which to fetch the status of this validation request via an HTTP GET","title":"Status Url","type":"string"},"verification_status":{"default":"Pending","description":"The current status of the verification request","title":"Verification Status","type":"string"}},"required":["diamond_id","request_id","status_url"],"title":"ValidationRequestResponse","type":"object"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}}}
```

## Check Validation Request Status

> Return the status of a validation Request.

```json
{"openapi":"3.1.0","info":{"title":"Grading Integration Service API","version":"development"},"paths":{"/v1/diamonds/{diamond_id}/validate/{request_id}":{"get":{"deprecated":true,"description":"Return the status of a validation Request.","operationId":"check_validation_request_status_v1_diamonds__diamond_id__validate__request_id__get","parameters":[{"in":"path","name":"request_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"}},{"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/ValidationFeedback"}}},"description":"Returned when a validation request has been answered by the DiamondID service."},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationRequestResponse"}}},"description":"Returned when a validation request has been made, but has not yet been answered by DiamondID."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":["Returned when either the diamond, or the specific validation request is not found."]},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":["Returned when the validation request has expired without a response from the DiamondID service."]},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GISError"}}},"description":"Returned when an internal error occurred within GIS."}},"summary":"Check Validation Request Status","tags":["API v1","Deprecated","Diamond Validation"]}}},"components":{"schemas":{"ValidationFeedback":{"description":"The full feedback on a validation operation, as returned by GIS.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation was requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"request_id":{"description":"The unique ID of the validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"requested_at":{"description":"The UTC datetime at which the validation request was created.","format":"date-time","title":"Requested At","type":"string"},"verification_description":{"description":"A message from DiamondID describing the validation status.","title":"Verification Description","type":"string"},"verification_error":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ValidationError"},"type":"object"},{"type":"null"}],"description":"Errors from validation, as a map of <field_name>: [<validation error>].","title":"Verification Error"},"verification_status":{"$ref":"#/components/schemas/ValidationAnswer","description":"The validation status returned by DiamondID."}},"required":["diamond_id","request_id","requested_at","verification_status","verification_description"],"title":"ValidationFeedback","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"},"ValidationAnswer":{"description":"Represents an answer from Diamond ID or GIS to validation request.\n\n- Pending: the validation request is pending (yet to processed by Diamond\n  ID or GIS)\n- Verified: The request has been successfully processed, and the diamond\n  verified.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n  a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n  missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n  outside tolerance) and appropriate feedback was returned.","enum":["Error","Invalid","Pending","Unverifiable","Verified"],"title":"ValidationAnswer","type":"string"},"ValidationRequestResponse":{"description":"A response to a request for the validation of a diamond.","properties":{"diamond_id":{"description":"The ID of the diamond for which validation has been requested.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"request_id":{"description":"The unique ID for this validation request.","pattern":"^[a-z\\d]{20,98}$","title":"Request Id","type":"string"},"status_url":{"description":"The URL from which to fetch the status of this validation request via an HTTP GET","title":"Status Url","type":"string"},"verification_status":{"default":"Pending","description":"The current status of the verification request","title":"Verification Status","type":"string"}},"required":["diamond_id","request_id","status_url"],"title":"ValidationRequestResponse","type":"object"},"GISError":{"description":"Returned when an error occurred whilst processing a GIS request.","properties":{"detail":{"description":"A description of the error which occurred.","title":"Detail","type":"string"}},"required":["detail"],"title":"GISError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}}}
```


---

# 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/grading-integration-service-gis-api/references/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.