---
title: "POST /v1/{+parent}/consentArtifacts"
method: POST
path: "/v1/{+parent}/consentArtifacts"
tags: ["projects"]
---

# POST /v1/{+parent}/consentArtifacts

`POST /v1/{+parent}/consentArtifacts`

Creates a new Consent artifact in the parent consent store.

## Path parameters

- `parent` string, required

## Request body

- ConsentArtifact — Documentation of a user's consent.
  - `name` string — Identifier. Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation.
  - `metadata` object — Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
  - `userId` string — Required. User's UUID provided by the client.
  - `witnessSignature` Signature — User signature.
    - `userId` string — Required. User's UUID provided by the client.
    - `image` Image — Raw bytes representing consent artifact content.
      - `rawBytes` string, byte — Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
      - `gcsUri` string — Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    - `metadata` object — Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    - `signatureTime` string, google-datetime — Optional. Timestamp of the signature.
  - `consentContentVersion` string — Optional. An string indicating the version of the consent information shown to the user.
  - `guardianSignature` Signature — User signature.
    - `userId` string — Required. User's UUID provided by the client.
    - `image` Image — Raw bytes representing consent artifact content.
      - `rawBytes` string, byte — Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
      - `gcsUri` string — Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    - `metadata` object — Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    - `signatureTime` string, google-datetime — Optional. Timestamp of the signature.
  - `consentContentScreenshots` Image[] — Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
    - `rawBytes` string, byte — Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
    - `gcsUri` string — Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
  - `userSignature` Signature — User signature.
    - `userId` string — Required. User's UUID provided by the client.
    - `image` Image — Raw bytes representing consent artifact content.
      - `rawBytes` string, byte — Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
      - `gcsUri` string — Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
    - `metadata` object — Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    - `signatureTime` string, google-datetime — Optional. Timestamp of the signature.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/healthcare.md) · [All operations](https://skmtc.net/google/apis/healthcare/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/healthcare/revisions/cdec6fe2315f/schema)