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 object[]

Datos específicos del acuerdo y sus usos permitidos

  • Array [
  • key string

    Identificador del dato

    Example: name
    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_uses object[]

    Usos permitidos para este dato

  • Array [
  • 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
    expires_at date

    Fecha de expiración del permiso de uso

    Example: 2034-12-06
    document_references array

    Referencias a documentos relacionados

    Example: ["669823ed4c91e6af2537f984","66b103a5d2e10ef171a9004b","669823ed4c91e6af2537f984","66b103a5d2e10ef171a9004b"]
  • ]
  • scope string

    Producto o servicio para el cuál está vigente el uso del dato. Corresponde al identificador del producto definido en su respectiva API

    Example: my_product_123
  • ]
  • 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": [
    {
    "key": "name",
    "data_category": "user.name.first",
    "data_uses": [
    {
    "use": "essential.service.authentication",
    "expires_at": "2034-12-06",
    "document_references": [
    "669823ed4c91e6af2537f984",
    "66b103a5d2e10ef171a9004b",
    "669823ed4c91e6af2537f984",
    "66b103a5d2e10ef171a9004b"
    ]
    }
    ],
    "scope": "my_product_123"
    }
    ],
    "user_reference": "user_123",
    "created_at": "2024-11-21T14:54:57.167Z",
    "previous_evidence_ids": [
    "evd_pNMroI2OEfrDNdi8xT6kOQ"
    ],
    "source_type": "DisclosureRequest"
    }