Consent States

patch

https://app.financekey.com/OData/ConsentStates({key})

The ConsentState table in the Consent package stores data related to a user's consent to a specific entity or policy. This table contains various states that represent a user's explicit consent status. The states may include 'pending', 'accepted', 'rejected', or 'revoked' for the specific entity. It contains information about when the consent was received, when it was updated and by whom, as well as any related notes. The ConsentState table is used to track and store

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

consentStateId

string

required

length between 1 and 32

ConsentStateId is a primary key field of the ConsentState table. It is an nvarchar data type with a maximum length of 32 characters. This field is used to uniquely identify each record in the ConsentState table, which stores information about the consents of users.

description

string

required

length ≥ 1

Nvarchar data type field named 'Description' in the table 'ConsentState' is used to store a short text description of the state stored in the 'State' field in the same table. This description helps further explain the status that is stored in the 'State' field.

comment

string | null

Miscellaneous notes and information for the entry or record.

badgeId

string | null

The field BadgeId in the ConsentState table is a data type of nvarchar with a maximum length of 32 characters. It is used to store the unique identification number associated with a user's badge or identification card for the purpose of tracking their consent. This field allows for easy identification and retrieval of consent records for a specific individual, making it a valuable component in managing and monitoring consent states.

badgeImage

string

required

length between 1 and 256

The BadgeImage field in the ConsentState table stores an image of the badge associated with the consent state. This field is of type nvarchar and has a maximum length of 256 characters, allowing for a wide range of images to be stored. The image could be in any format such as JPEG, PNG, or GIF and could display a logo or symbol related to the consent state. This field provides visual representation of the consent state and can be used to quickly identify the state associated with a particular record.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!