Create Agreement Responses Agreement Response
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Unique idempotency key (UUID v4). Repeated requests with the same key return the original response.
Body Parameters
The ID of the agreement being accepted.
The individual (consumer) who accepted the agreement.
Identifies who accepted on the individual behalf.
Optional free-text captured at the point of acceptance.
Response
Consent record created successfully.
Response Attributes
Agreement identifier.
Individual identifier.
UTC timestamp when the response was accepted.
Response code (1 = accepted).
Who accepted on the individual behalf.
Free-text captured at the point of acceptance.
Request body is missing or contains invalid values.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Bearer token is missing or invalid.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Caller token does not resolve to a known customer shard.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
The referenced agreementId does not exist within the caller scope.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
A consent record for this individual and agreement already exists and is active.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.