Saltar al contenido principal

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 Agreements y evidencia.

id string

Identificador único del acuerdo.

Example: agr_IdBeyWCa1ENLUYnPRLpCUg
version integer

Versión del acuerdo

Example: 1
subject_id string

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_type string

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

Example: Entity
data_permissions object[]

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

  • Array [
  • data_category string

    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_label string

    Identificador del dato

    Example: name
    data_use string

    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_type stringnullable

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

    Possible values: [branch, product]

    scope_id stringnullable

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

    scope_version stringnullable

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

    expires_at date

    Fecha de expiración del permiso de uso

  • ]
  • user_reference string

    Referencia de usuario proporcionada por el cliente.

    Example: user_123
    created_at date-time

    Fecha y hora de creación del acuerdo.

    Example: 2024-11-21T14:54:57.167Z
    previous_evidence_ids string[]

    IDs de evidencias anteriores relacionadas con este acuerdo

    Example: ["evd_pNMroI2OEfrDNdi8xT6kOQ"]
    source_type string

    Fuente del acuerdo. Puede ser DisclosureRequest o ConsentAction.

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