Adicionar firmante

Adicionar firmante

POST https://api.zapsign.com.br/api/v1/docs/{{doc_token}}/add-signer/

Add a signer to a document.

Encabezado

Nombre	Tipo	Descripción
Authorization*	string	API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Nombre	Tipo	Descripción
name*	string	El nombre del firmante. Obligatorio
email	string	Correo electrónico del firmante
phone_country	string	El código de país del teléfono del firmante.
phone_number	string	El número de teléfono del firmante. Ejemplo: "11998989222".
require_document	boolean	Si es true, se requerirá que el firmante proporcione su información de identificación (país, tipo de documento y número de documento). Esta información se incluirá en el informe de firma. Valor predeterminado: false.
require_document_data	objeto	Si se definen el país, tipo de documento y número de documento, el firmante no podrá modificar esta información durante el proceso de firma. Si solo se definen el país y el tipo de documento, el firmante deberá ingresar el número document_country (string). Posibles valores: "br" (Brazil), "co" (Colombia), "mx" (Mexico), "us" (United Stated), "ar" (Argentina), "pe" (Peru), "cl" (Chile), "other" (Other country). document_type (string). Posibles valores: "national_id", "foreign_id", "driver_license", "ppt". document_number (string): Por defecto: "".
auth_mode	string	Elige el método de autenticación para el firmante. Esto adiciona más seguridad al documento firmado, para conocer los posibles valores haz clic aqui
lock_name	boolean	Si se establece en true, el firmante no podrá cambiar su nombre durante el proceso de firma
lock_email	boolean	Si se establece en true, el firmante no podrá cambiar su correo electrónico durante el proceso de firma
lock_phone	boolean	Si se establece en true, el firmante no podrá cambiar su celular durante el proceso de firma
qualification	string	Rol del firmante que se mostrará en el informe de firma. Por ejemplo "Testigo" se mostrará como "Firmo como Testigo".
external_id	string	ID del firmante en tu aplicación.
send_automatic_email	boolean	Si se establece en true, ZapSign enviará automáticamente un correo al firmante con el enlace para firmar el documento. Enviará un recordatorio para firmar el documento.
send_automatic_whatsapp	boolean	Si se establece en true, ZapSign enviará automáticamente un WhatsApp al firmante con el enlace para firmar el documento. Enviará un recordatorio para firmar el documento. Recuerda que se deben tener créditos para enviar por WhatsApp
redirect_link	string	Enlace al que se redirige al firmante después de firmar el documento. Después de firmar se mostrará un botón de "Continuar". Recuerda incluir http:// o https:// al inicio del enlace
send_automatic_whatsapp_signed_file	boolean	Si se establece en true, ZapSign enviará un mensaje por WhatsApp al firmante con el enlace al documento firmado. Recuerda que se deben tener créditos para enviar por WhatsApp.
selfie_validation_type	String	Métodos avanzados de biometría para identificar al firmante: "liveness-document-match": Reconocimiento facial que valida que el firmante esté presente y sea el mismo que la foto del documento suministrada. "identity-verification": Validación del documento y biometría facial, asegurando que el firmante esté presente, que el documento sea real y que esté registrado en bases de datos gubernamentales.
require_document_photo	Boolean	Si se establece en true, se pedirá al firmante que tome una foto del frente y anverso del documento de identidad durante el proceso de firma (no hay validación de la foto).
require_selfie_photo	Boolean	Si se establece en true, se pedirá al firmante que tome una selfie durante el proceso de firma (no hay validación de la foto). Por defecto es false.

200 Signer added successfully

{
    "external_id": "",
    "sign_url": "https://app.zapsign.com.br/verificar/b5ade7f0-8bc2-463a-8475-d67eb7f58167",
    "token": "b5ade7f0-8bc2-463a-8475-d67eb7f58167",
    "status": "new",
    "name": "John Doe",
    "lock_name": false,
    "email": "",
    "lock_email": false,
    "hide_email": false,
    "blank_email": false,
    "phone_country": "55",
    "phone_number": "",
    "lock_phone": false,
    "hide_phone": false,
    "blank_phone": false,
    "times_viewed": 0,
    "last_view_at": null,
    "signed_at": null,
    "auth_mode": "assinaturaTela",
    "qualification": "",
    "require_selfie_photo": false,
    "require_document_photo": false,
    "geo_latitude": null,
    "geo_longitude": null,
    "redirect_link": "",
    "signature_image": null,
    "visto_image": null,
    "document_photo_url": "",
    "document_verse_photo_url": "",
    "selfie_photo_url": "",
    "selfie_photo_url2": "",
    "send_via": "email"
}

Request

Add signer | ZapSign WorkspacePostman