> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.morphiaone.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.morphiaone.ai/_mcp/server.

# Stage an accepted colour Candidate as a catalogue draft

POST https://api.morphiaone.ai/v1/digitisation/candidates/{candidate_id}/stage
Content-Type: application/json

Writes an `accepted` candidate into your catalogue as a draft. Send the
`candidate_sha256` that was accepted: a candidate pending or rejected answers
`409 CANDIDATE_NOT_ACCEPTED`, and another digest `409 CANDIDATE_DIGEST_MISMATCH`.
Acceptance is checked again as the draft is written; if what the candidate was
measured from no longer holds, the answer is `409 CANDIDATE_NOT_STAGEABLE`.
The draft's `display_color` is the candidate's measured colour, so its
applications take no `render_color`. A `new_variant` destination creates an
unpublished variant whose revision 1 is the draft; an `external_ref` already in
use answers `409 EXTERNAL_REF_TAKEN` and is never read as the variant to revise.
A `variant_revision` destination writes the variant's next draft revision only
while it is at the `expected_generation` you read, or answers
`409 GENERATION_CONFLICT`. The draft renders nothing until you approve and
publish it. A refused stage writes nothing.
Send an `Idempotency-Key`: it is required, and a retry with the same key and
the same request answers the first response, byte for byte, with
`Idempotency-Replayed: true`.
Requires the `catalogue.write` scope; served only where both digitisation and
the catalogue are enabled for your environment.

Reference: https://docs.morphiaone.ai/api-reference/endpoints/digitisation/candidates-stage

## Authentication

- `X-API-Key` header (required) — API key for one environment of your account. Keep server-side; never expose in browser clients.

## Request

### Path parameters

- `candidate_id` (string, required)

### Headers

- `Idempotency-Key` (string, optional, nullable)

### Body (application/json)

This endpoint expects an object.

- `candidate_sha256` (string, required)
- `destination` (V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestination, required)

## Response

### 201

The stage receipt: the draft is written. A replay under the same Idempotency-Key answers the same receipt with Idempotency-Replayed: true

- `assessment_id` (string, required)
- `candidate_id` (string, required)
- `candidate_sha256` (string, required)
- `created_at` (datetime, required)
- `destination` (enum, required)
  - Allowed values: `new_variant`, `variant_revision`
- `expected_generation` (integer, required, nullable)
- `id` (string, required)
- `reviewed_at` (datetime, required)
- `reviewed_by` (ReviewActor, required) — Who made a decision: ``user``, a person in the Platform, or ``api_key``. It names no person; the Platform shows who.
- `revision` (integer, required)
- `staged_by` (ReviewActor, required) — Who made a decision: ``user``, a person in the Platform, or ``api_key``. It names no person; the Platform shows who.
- `variant_id` (string, required)

## Errors

### 400 Bad Request Error

Invalid stage or Idempotency-Key

- `error` (ErrorDetail, required)

### 401 Unauthorized Error

Missing or invalid API key

- `error` (ErrorDetail, required)

### 403 Forbidden Error

API key lacks the catalogue.write scope, or its account lets a key stage only a person's acceptance (HUMAN_REVIEW_REQUIRED)

- `error` (ErrorDetail, required)

### 404 Not Found Error

No such candidate or variant

- `error` (ErrorDetail, required)

### 409 Conflict Error

Candidate not accepted or no longer stageable, another digest, external_ref taken, variant retired or moved, or an idempotency conflict

- `error` (ErrorDetail, required)

### 503 Service Unavailable Error

Digitisation unavailable

- `error` (ErrorDetail, required)

## Types

### V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestination

- `kind`: `new_variant` (NewVariantStageDestination)
  - `applications` (list of V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf0ApplicationsItems, required)
  - `default_application_id` (string, optional, nullable)
  - `external_ref` (string, optional, nullable)
- `kind`: `variant_revision` (VariantRevisionStageDestination)
  - `applications` (list of V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf1ApplicationsItems, required)
  - `expected_generation` (integer, required)
  - `variant_id` (string, required)
  - `default_application_id` (string, optional, nullable)

### ReviewActor

Who made a decision: ``user``, a person in the Platform, or ``api_key``. It names no person; the Platform shows who.

- `type` (enum, required)
  - Allowed values: `user`, `api_key`

### ErrorDetail

- `code` (string, required)
- `message` (string, required)
- `request_id` (string, required)
- `details` (ErrorDetailDetails, optional)
- `doc_url` (string, optional, nullable)
- `retryable` (boolean, optional, nullable)

### V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf0ApplicationsItems

One application definition of the staged draft: an id, a category and its custom options. It renders with the candidate's measured colour, which is the draft's ``display_color``, so it takes no ``render_color``.

- `application_id` (string, required)
- `category` (string, required)
- `blend` (string, optional, nullable)
- `components` (map from string to map from string to V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf0ApplicationsItemsComponents, optional, nullable)
- `design` (string, optional, nullable)
- `finish` (string, optional, nullable)
- `intensity` (string, optional, nullable)
- `placement` (string, optional, nullable)
- `style` (string, optional, nullable)

### V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf1ApplicationsItems

One application definition of the staged draft: an id, a category and its custom options. It renders with the candidate's measured colour, which is the draft's ``display_color``, so it takes no ``render_color``.

- `application_id` (string, required)
- `category` (string, required)
- `blend` (string, optional, nullable)
- `components` (map from string to map from string to V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf1ApplicationsItemsComponents, optional, nullable)
- `design` (string, optional, nullable)
- `finish` (string, optional, nullable)
- `intensity` (string, optional, nullable)
- `placement` (string, optional, nullable)
- `style` (string, optional, nullable)

### ErrorDetailDetails

- map from string to any
- list of map from string to any

### V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf0ApplicationsItemsComponents

Where one design role field's colour comes from (Foundation V1 D5): exactly one of ``ref``, an appearance path (``appearance.display_color``), or ``value``, a colour the partner states.

- `ref` (string, optional, nullable)
- `value` (string, optional, nullable)

### V1DigitisationCandidatesCandidateIdStagePostRequestBodyContentApplicationJsonSchemaDestinationOneOf1ApplicationsItemsComponents

Where one design role field's colour comes from (Foundation V1 D5): exactly one of ``ref``, an appearance path (``appearance.display_color``), or ``value``, a colour the partner states.

- `ref` (string, optional, nullable)
- `value` (string, optional, nullable)

## Examples

**Request**

```json
{
  "candidate_sha256": "string",
  "destination": {
    "applications": [
      {
        "application_id": "string",
        "category": "string"
      }
    ],
    "kind": "string"
  }
}
```

**Response**

```json
{
  "assessment_id": "assessment_3t38gf4mbt0y96z8pzmp4w5mpq",
  "candidate_id": "candidate_5w2kq8n4fz7yr3tm6vx9bhcj1d",
  "candidate_sha256": "e1e9fdf2e1a9fe90712dad6a3247af7c4b6b6144d770a9070983f1d665fe71bb",
  "created_at": "2026-10-22T03:26:12.440117Z",
  "destination": "new_variant",
  "expected_generation": null,
  "id": "stage_4m8q2v6x0z3c7f1h5k9n2r6t8w",
  "reviewed_at": "2026-10-22T03:24:47.902311Z",
  "reviewed_by": {
    "type": "user"
  },
  "revision": 1,
  "staged_by": {
    "type": "api_key"
  },
  "variant_id": "var_6p2r8t4v0x6z2b8d4f0h6k2m8q"
}
```

**SDK Code**

```python Digitisation_candidatesStage_example
import requests

url = "https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage"

payload = {
    "candidate_sha256": "string",
    "destination": {
        "applications": [
            {
                "application_id": "string",
                "category": "string"
            }
        ],
        "kind": "string"
    }
}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Digitisation_candidatesStage_example
const url = 'https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"candidate_sha256":"string","destination":{"applications":[{"application_id":"string","category":"string"}],"kind":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Digitisation_candidatesStage_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage"

	payload := strings.NewReader("{\n  \"candidate_sha256\": \"string\",\n  \"destination\": {\n    \"applications\": [\n      {\n        \"application_id\": \"string\",\n        \"category\": \"string\"\n      }\n    ],\n    \"kind\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Digitisation_candidatesStage_example
require 'uri'
require 'net/http'

url = URI("https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"candidate_sha256\": \"string\",\n  \"destination\": {\n    \"applications\": [\n      {\n        \"application_id\": \"string\",\n        \"category\": \"string\"\n      }\n    ],\n    \"kind\": \"string\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Digitisation_candidatesStage_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"candidate_sha256\": \"string\",\n  \"destination\": {\n    \"applications\": [\n      {\n        \"application_id\": \"string\",\n        \"category\": \"string\"\n      }\n    ],\n    \"kind\": \"string\"\n  }\n}")
  .asString();
```

```php Digitisation_candidatesStage_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage', [
  'body' => '{
  "candidate_sha256": "string",
  "destination": {
    "applications": [
      {
        "application_id": "string",
        "category": "string"
      }
    ],
    "kind": "string"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Digitisation_candidatesStage_example
using RestSharp;

var client = new RestClient("https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"candidate_sha256\": \"string\",\n  \"destination\": {\n    \"applications\": [\n      {\n        \"application_id\": \"string\",\n        \"category\": \"string\"\n      }\n    ],\n    \"kind\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Digitisation_candidatesStage_example
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "candidate_sha256": "string",
  "destination": [
    "applications": [
      [
        "application_id": "string",
        "category": "string"
      ]
    ],
    "kind": "string"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.morphiaone.ai/v1/digitisation/candidates/candidate_id/stage")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```