Agreement

Representa el estado actual de los permisos de un usuario para utilizar datos de acuerdo a la taxonomía de datos y usos de datos. Puede ser actualizado a través de distintas acciones del usuario y empresa en el tiempo.

info

Para más detalles, revisa nuestra sección de conceptos generales.

idstring

Identificador único del acuerdo.

Example: agr_IdBeyWCa1ENLUYnPRLpCUg

versioninteger

Versión del acuerdo

Example: 1

subject_idstring

Identificador único del usuario del acuerdo. Puede corresponder al identificador de un Identity o Entity. El subject_type indica el tipo del usuario en cuestión.

Example: ent_ma21KLsmaslopask912Aa2

subject_typestring

Tipo de sujeto del acuerdo. Puede ser Identity o Entity.

Example: Entity

version_source_typestring

Tipo de fuente de la versión del acuerdo. Puede ser DisclosureRequest, ConsentAction o ConsentCommit.

Example: ConsentCommit

version_source_idstring

Identificador único de la fuente de la versión del acuerdo. Puede ser el identificador de un DisclosureRequest, ConsentAction o ConsentCommit.

Example: consact_1B2M2Y8AsgTpgAmY7PhCfg

data_permissions object[]

Datos procesados del agreement de acuerdo a la taxonomía de datos

Array [

data_categorystring

Categoría del dato personal. Sigue la taxonomía de datos. Para más información, consulta el detalle de la taxonomía

Example: user.name.first

data_labelstring

Identificador del dato

Example: name

data_usestring

Propósito específico del uso del dato. Sigue la taxonomía de usos de datos. Para más información, consulta el detalle de la taxonomía

Example: essential.service.authentication

scope_typestringnullable

Tipo de alcance del uso del dato. Un dato puede estar dentro del contexto de un producto o de una branch

Possible values: [product, branch]

scope_idstringnullable

Identificador del producto o filial para la cual está vigente el uso del dato.

scope_versionstringnullable

Versión del producto o filial para la cual está vigente el uso del dato.

expires_atstring<date>

Fecha de expiración del permiso de uso

]

user_referencestring

Referencia de usuario proporcionada por el cliente.

Example: user_123

previous_evidence_idsstring[]

IDs de evidencias anteriores relacionadas con este acuerdo

Example: ["evd_pNMroI2OEfrDNdi8xT6kOQ"]

created_atstring<date-time>

Fecha y hora de creación del acuerdo.

Example: 2024-11-21T14:54:57.167Z

Agreement

{
  "id": "agr_IdBeyWCa1ENLUYnPRLpCUg",
  "version": 1,
  "subject_id": "ent_ma21KLsmaslopask912Aa2",
  "subject_type": "Entity",
  "version_source_type": "ConsentCommit",
  "version_source_id": "consact_1B2M2Y8AsgTpgAmY7PhCfg",
  "data_permissions": [
    {
      "data_category": "user.name.first",
      "data_label": "name",
      "data_use": "essential.service.authentication",
      "scope_type": "product",
      "scope_id": "string",
      "scope_version": "string",
      "expires_at": "2024-07-29"
    }
  ],
  "user_reference": "user_123",
  "previous_evidence_ids": [
    "evd_pNMroI2OEfrDNdi8xT6kOQ"
  ],
  "created_at": "2024-11-21T14:54:57.167Z"
}