Provenance

GIS provides a separate endpoint /v2/diamonds/{diamond_id} (reference) which allows the grading lab to retrieve the provenance of a diamond.

Required Data

• Tracr ID

Example request:

GET /v2/diamonds/kzsrfx4dxupa7a8uyn15wund

Example response:

{
    "diamond_id": "kzsrfx4dxupa7a8uyn15wund",
    "shape": "Princess",
    "colour": "G",
    "clarity": "VS1",
    "carats": "0.001",
    "fancy_colour": null,
    "provenance": {
        "provenance_name": "Botswana",
        "provenance_type": "Country",
        "country_code": "BW",
        "mine_name": null,
        "is_locked": false
    },
    "rough_check": true
}

HTTP response status codes

200

200 : Success

Returned when the request has been successfully processed.

Example response (see main example above).

402

402 : Payment Required

Returned when a diamond is locked.

Example:

{
    "detail": "This diamond is locked and needs to be unlocked by the participant."
}

404

404 : Not Found

Returned when a Diamond is not found in the Tracr network.

Example:

{
    "detail": "Diamond cannot be found in Tracr"
}

422

422 : Unprocessable Entity

Returned when the request doesn't match the endpoint data requirements.

Example:

{
    "detail": [
        {
            "loc": [
                "path",
                "diamond_id"
            ],
            "msg": "string does not match regex \"^[a-z\\d]{20,98}$\"",
            "type": "value_error.str.regex",
            "ctx": {
                "pattern": "^[a-z\\d]{20,98}$"
            }
        }
    ]
}

500

500 : Internal Server Error

Returned when an internal error occurred within GIS. Please contact Tracr Support if you encounter this issue.