Create a gate evidence
Projects module
POST/gate-evidencegateEvidence.create
Evidence for a gate criterion. One evidence spine serves every criterion. Creates a gate evidence. 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 projects.gate.evidence.write.
- OAuth scopes: projects.
- 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: GateEvidenceCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| criterion_id | CriterionId | Yes | Gate criterion identifier from `xpms.dim_gate_criterion`.Constraints: pattern ^G[1-9]\.[A-Z0-9_]+$ |
| record_id | string (uuid) | null | No | Identifier of the record that evidences the criterion. |
| assertion_rank | integer | Yes | Assertion rank of the evidence, 0 to 4.Constraints: range 0 to any |
| evidence_uri | string | Yes | Where the evidence lives: a document or record URI.Constraints: length 1 to 2000 |
| note | string | null | No | Note on the evidence.Constraints: length 1 to 2000 |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"criterion_id": "G1.BUDGET_ENVELOPE",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"assertion_rank": 4,
"evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "Signed by the venue manager."
}Response 201: GateEvidence
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the gate evidence. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| criterion_id | CriterionId | Yes | Gate criterion identifier from `xpms.dim_gate_criterion`.Constraints: pattern ^G[1-9]\.[A-Z0-9_]+$ |
| record_id | string (uuid) | null | Yes | Identifier of the record that evidences the criterion. |
| attested_by | string (uuid) | null | Yes | Identifier of the person who attested the evidence. |
| attested_at | string (date-time) | Yes | When the evidence was attested. |
| assertion_rank | integer | Yes | Assertion rank of the evidence, 0 to 4.Constraints: range 0 to any |
| evidence_uri | string | null | Yes | Where the evidence lives: a document or record URI.Constraints: length 1 to 2000 |
| note | string | null | Yes | Note on the evidence.Constraints: length 1 to 2000 |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"criterion_id": "G1.BUDGET_ENVELOPE",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"attested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"attested_at": "2026-10-08T14:30:00Z",
"assertion_rank": 4,
"evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "Signed by the venue manager."
}Code samples
curl -X POST "$XOS_BASE_URL/gate-evidence" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","criterion_id":"G1.BUDGET_ENVELOPE","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","assertion_rank":4,"evidence_uri":"urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Signed by the venue manager."}'const { data } = await xos.gateEvidence.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"criterion_id": "G1.BUDGET_ENVELOPE",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"assertion_rank": 4,
"evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "Signed by the venue manager."
});response = xos.gate_evidence.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "criterion_id": "G1.BUDGET_ENVELOPE", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "assertion_rank": 4, "evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "note": "Signed by the venue manager."})xos gate-evidence create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","criterion_id":"G1.BUDGET_ENVELOPE","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","assertion_rank":4,"evidence_uri":"urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Signed by the venue manager."}'