Saltar al contenido principal

ConsentFormEntry

ConsentFormEntry

Un consent form entry representa un envío exitoso de un consent form. Guarda los datos capturados y referencia el subject y el consent form/version usados al momento del envío.

idstringrequired

Identificador único. Debe empezar con cfent_.

Example: cfent_wAspvmEr4ACDZaPUtfwjsA
consent_form_idstringrequired
Example: cform_wAspvmEr4ACDZaPUtfwjsA
consent_form_versionintegerrequired
Example: 2
subject_idstringrequired
Example: ent_wAspvmEr4ACDZaPUtfwjsA
subject_typestringrequired

Possible values: [Entity, Identity]

Example: Entity
user_referencestringnullable
Example: customer-123
consent_action_idstringnullable

Token de la acción de consentimiento creada cuando el entry contiene exactamente un consentimiento.

Example: consact_wAspvmEr4ACDZaPUtfwjsA
consent_commit_idstringnullable

Token del consent commit creado cuando el entry contiene múltiples consentimientos.

Example: ccom_wAspvmEr4ACDZaPUtfwjsA
data objectrequired
property name*any
Example: {"full_name":"Jane Doe","email":"jane@soyio.id"}
government_validation objectnullable
idstring

Identificador de la solicitud de validación del formulario. Debe empezar con cfvreq_.

Example: cfvreq_wAspvmEr4ACDZaPUtfwjsA
statusstring

Possible values: [pending, validating, successful, failed]

Example: successful
validation_attempt_idstringnullable
Example: va_wAspvmEr4ACDZaPUtfwjsA
validation_attempt_statusstringnullable
Example: successful
government_id_validation_statusstringnullable
Example: verified
government_check_providerstringnullable
Example: certificadora_del_sur
validation_errorsobject[]
created_atdate-timenullable
Example: 2024-03-20T15:30:00Z
created_atdate-timerequired
Example: 2024-03-20T15:30:00Z
event_logs object[]
  • Array [
  • timestampdate-time

    Fecha y hora del evento

    Example: 2024-03-20T15:30:00Z
    typestring

    Tipo de evento

    Example: created
    descriptionstring

    Descripción del evento

    Example: Consent template created
    payloadobject

    Datos adicionales del evento

    Example: {"version":1,"created_by":"cusr_123"}
  • ]
  • granted_template_idsstring[]
    Example: ["constpl_wAspvmEr4ACDZaPUtfwjsA"]
    subject objectnullable
    idstring
    Example: ent_wAspvmEr4ACDZaPUtfwjsA
    typestring

    Possible values: [Entity, Identity]

    Example: Entity
    user_referencestringnullable
    Example: customer-123
    created_atdate-time
    Example: 2024-03-20T15:30:00Z
    updated_atdate-time
    Example: 2024-03-20T15:30:00Z
    ConsentFormEntry
    {
    "id": "cfent_wAspvmEr4ACDZaPUtfwjsA",
    "consent_form_id": "cform_wAspvmEr4ACDZaPUtfwjsA",
    "consent_form_version": 2,
    "subject_id": "ent_wAspvmEr4ACDZaPUtfwjsA",
    "subject_type": "Entity",
    "user_reference": "customer-123",
    "consent_action_id": "consact_wAspvmEr4ACDZaPUtfwjsA",
    "consent_commit_id": "ccom_wAspvmEr4ACDZaPUtfwjsA",
    "data": {
    "full_name": "Jane Doe",
    "email": "jane@soyio.id"
    },
    "government_validation": {
    "id": "cfvreq_wAspvmEr4ACDZaPUtfwjsA",
    "status": "successful",
    "validation_attempt_id": "va_wAspvmEr4ACDZaPUtfwjsA",
    "validation_attempt_status": "successful",
    "government_id_validation_status": "verified",
    "government_check_provider": "certificadora_del_sur",
    "validation_errors": [
    {}
    ],
    "created_at": "2024-03-20T15:30:00Z"
    },
    "created_at": "2024-03-20T15:30:00Z",
    "event_logs": [
    {
    "timestamp": "2024-03-20T15:30:00Z",
    "type": "created",
    "description": "Consent template created",
    "payload": {
    "version": 1,
    "created_by": "cusr_123"
    }
    }
    ],
    "granted_template_ids": [
    "constpl_wAspvmEr4ACDZaPUtfwjsA"
    ],
    "subject": {
    "id": "ent_wAspvmEr4ACDZaPUtfwjsA",
    "type": "Entity",
    "user_reference": "customer-123",
    "created_at": "2024-03-20T15:30:00Z",
    "updated_at": "2024-03-20T15:30:00Z"
    }
    }