Create an asset custody
Assets module
POST/asset-custodyassetCustodyEntries.create
An append-only custody ledger entry. Creates an asset custody. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability assets.custody.write.
- OAuth scopes: assets.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: AssetCustodyCreate
| Field | Type | Required | Description |
|---|---|---|---|
| asset_unit_id | string (uuid) | Yes | Identifier of the asset unit. |
| custodian_membership_id | string (uuid) | null | No | Identifier of the member who holds the unit. |
| custodian_engagement_id | string (uuid) | null | No | Identifier of the external engagement that holds the unit. |
| venue_id | string (uuid) | null | No | Identifier of the place the unit is kept. |
| project_id | string (uuid) | null | No | Identifier of the project the unit is out for. |
| note | string | null | No | Hand-over note.Constraints: length 0 to 1000 |
{
"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custodian_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custodian_engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "Issued for load-in."
}Response 201: AssetCustody
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the asset custody. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| asset_unit_id | string (uuid) | Yes | Identifier of the asset unit. |
| custodian_membership_id | string (uuid) | null | Yes | Identifier of the member who holds the unit. |
| custodian_engagement_id | string (uuid) | null | Yes | Identifier of the external engagement that holds the unit. |
| venue_id | string (uuid) | null | Yes | Identifier of the place the unit is kept. |
| project_id | string (uuid) | null | Yes | Identifier of the project the unit is out for. |
| note | string | null | Yes | Hand-over note.Constraints: length 0 to 1000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custodian_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custodian_engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "Issued for load-in."
}Code samples
curl -X POST "$XOS_BASE_URL/asset-custody" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"asset_unit_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","custodian_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","custodian_engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Issued for load-in."}'const { data } = await xos.assetCustodyEntries.create({
"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custodian_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custodian_engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "Issued for load-in."
});response = xos.asset_custody_entries.create({"asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "custodian_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "custodian_engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "note": "Issued for load-in."})xos asset-custody-entries create --data '{"asset_unit_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","custodian_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","custodian_engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Issued for load-in."}'