Digital Signatures

Introduction

The Digital Signatures API enables authenticated employees to create and manage their digital signature profiles, including signature images and organizational details. These signatures are used to authenticate pharmacovigilance documents and ICSR exports.

Base URL

/api/v1/firmas

Authentication

All signature endpoints require employee authentication. The system automatically links signatures to the authenticated employee’s profile.

Authorization: Bearer <your_token>

Get My Signature Profile

Retrieve the signature profile for the authenticated employee. Creates a default profile if none exists.

curl -X GET https://api.vigia.com/api/v1/firmas/me \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

integer

Unique signature profile ID

empleado_id

integer

Associated employee ID

nombre

string

Signer’s full name

cargo

string

Job title or position

company

string

Company or organization name

telefono

string

Phone number

celular

string

Mobile phone number

email_alt

string

Alternative email address

website

string

Company website URL

logo_url

string

URL to company logo image

firma_img_url

string

URL to handwritten signature image

Example Response

{
  "id": 1,
  "empleado_id": 42,
  "nombre": "Dr. Juan Pérez Ramírez",
  "cargo": "Químico Farmacéutico - Responsable de Farmacovigilancia",
  "company": "OTARVASQ S.A.C.",
  "telefono": "+51-1-2345678",
  "celular": "+51-987-654-321",
  "email_alt": "[email protected]",
  "website": "https://www.otarvasq.com",
  "logo_url": "/uploads/firmas_42/logo.png",
  "firma_img_url": "/uploads/firmas_42/firma.png",
  "is_default": true,
  "socials": null,
  "html": null,
  "ui_prefs": null
}

Update Signature Profile

Update signature profile information for the authenticated employee.

curl -X PUT https://api.vigia.com/api/v1/firmas/1 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "nombre": "Dr. Juan Pérez Ramírez",
    "cargo": "Químico Farmacéutico",
    "company": "OTARVASQ S.A.C.",
    "celular": "+51-987-654-321",
    "email_alt": "[email protected]",
    "website": "https://www.otarvasq.com"
  }'

Path Parameters

integer

required

Signature profile ID (must belong to the authenticated employee)

Request Body

All fields are optional. Only provided fields will be updated.

nombre

string

Full name of the signer

cargo

string

Job title or position

company

string

Company or organization name

telefono

string

Phone number

celular

string

Mobile phone number

anexo

string

Phone extension

email_alt

string

Alternative email address

website

string

Company website URL

address

string

Physical address

logo_url

string

URL to company logo (cleaned automatically)

firma_img_url

string

URL to signature image (cleaned automatically)

socials

object

Social media links (key-value pairs)

html

string

Custom HTML signature template

is_default

boolean

Whether this is the default signature

ui_prefs

object

UI preferences for signature display

Response

Returns the updated signature profile.

Upload Signature Assets

Upload signature image or company logo.

curl -X POST https://api.vigia.com/api/v1/firmas/1/assets \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "field=firma_img" \
  -F "file=@/path/to/signature.png"

Path Parameters

integer

required

Signature profile ID (must belong to authenticated employee)

Request Parameters

file

required

Image file to upload (PNG, JPG, or other image formats)

field

string

required

Asset type to upload:

"logo": Company logo
"firma_img": Handwritten signature image

Response

Returns the updated signature profile with the new asset URL.

Storage

Files are stored in:

uploads/firmas_{empleado_id}/

URLs are automatically cleaned to extract the /uploads/ path.

Signature Usage in Documents

Signatures are automatically applied to documents in the following contexts:

ICSR Export with Signature

When exporting ICSR reports to DIGEMID format, the signature profile of the authenticated user is embedded:

GET /api/v1/icsr/{icsr_id}/export/digemid

curl -X GET "https://api.vigia.com/api/v1/icsr/123/export/digemid?formato=pdf" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o icsr_report.pdf

The generated PDF includes:

Signer’s name and job title
Handwritten signature image (firma_img_url)
Company logo (if configured)
Contact information (phone, email)
Company website

Signature Context in Exports

The following fields from the signature profile are included:

Field	Use in Export
`nombre`	Displayed as signer name
`cargo`	Job title below signature
`company`	Organization name
`celular` / `telefono`	Contact phone number
`email_alt`	Contact email
`website`	Company URL
`firma_img_url`	Embedded signature image
`logo_url`	Header/footer logo (optional)

OTP Verification Workflow

For critical documents requiring OTP verification:

Initiate Export: User requests document export
Generate OTP: System sends OTP code to registered email/phone
Verify OTP: User provides OTP code
Apply Signature: System embeds signature in document
Generate Document: Final document with digital signature is created

OTP verification is handled by separate authentication endpoints and is automatically integrated with signature application.

Signature Image Guidelines

Recommended Specifications

Format: PNG (transparent background) or JPG
Dimensions: 300-500 pixels wide, 100-150 pixels high
File Size: Under 500 KB
DPI: 150-300 for print quality
Background: Transparent PNG recommended

Creating a Digital Signature

Sign on white paper with black/blue pen
Scan at high resolution (300 DPI)
Use image editing software to:
- Crop to signature only
- Remove background (make transparent)
- Adjust contrast for clarity
Save as PNG with transparency
Upload using the assets endpoint

Security Considerations

Access Control

Employees can only view and update their own signature profiles
Signature IDs are validated against the authenticated employee
Unauthorized access returns 404 error

Data Protection

Signature images are stored in employee-specific directories
URLs are sanitized to prevent path traversal
File uploads are validated for type and size

Audit Trail

When signatures are applied to documents:

The authenticated user’s ID is recorded
Timestamp of signature application is logged
Document export records include signer information

Error Codes

Status Code	Description
200	Success - Signature retrieved or updated
201	Created - Asset uploaded successfully
400	Bad Request - Invalid field value or file format
404	Not Found - Signature profile not found or no permission
500	Internal Server Error - File storage or processing error

Complete Example: Setting Up a Signature

Python

import requests

# 1. Get current signature profile
url = "https://api.vigia.com/api/v1/firmas/me"
headers = {"Authorization": f"Bearer {token}"}
response = requests.get(url, headers=headers)
signature = response.json()

print(f"Current signature ID: {signature['id']}")

# 2. Update signature details
update_url = f"https://api.vigia.com/api/v1/firmas/{signature['id']}"
update_data = {
    "nombre": "Dr. Juan Pérez Ramírez",
    "cargo": "Químico Farmacéutico - Responsable de Farmacovigilancia",
    "company": "OTARVASQ S.A.C.",
    "celular": "+51-987-654-321",
    "email_alt": "[email protected]",
    "website": "https://www.otarvasq.com"
}

response = requests.put(update_url, headers=headers, json=update_data)
print("Signature updated:", response.json())

# 3. Upload signature image
asset_url = f"https://api.vigia.com/api/v1/firmas/{signature['id']}/assets"
files = {"file": open("my_signature.png", "rb")}
data = {"field": "firma_img"}

response = requests.post(asset_url, headers=headers, files=files, data=data)
print("Signature image uploaded:", response.json())

# 4. Upload company logo
files = {"file": open("company_logo.png", "rb")}
data = {"field": "logo"}

response = requests.post(asset_url, headers=headers, files=files, data=data)
print("Logo uploaded:", response.json())

# 5. Verify final signature profile
response = requests.get(url, headers=headers)
final_signature = response.json()
print("\nFinal signature profile:")
print(f"Name: {final_signature['nombre']}")
print(f"Title: {final_signature['cargo']}")
print(f"Signature image: {final_signature['firma_img_url']}")
print(f"Logo: {final_signature['logo_url']}")

ICSR Export

Export ICSR reports with embedded signatures

Document Management

Create and manage documents

Authentication

ICSR

IPS Reports

Document Management

Surveillance

OCR & NLP

Products & MedDRA

Digital Signatures

Introduction

Base URL

Authentication

Get My Signature Profile

Response

Example Response

Update Signature Profile

Path Parameters

Request Body

Response

Upload Signature Assets

Path Parameters

Request Parameters

Response

Storage

Signature Usage in Documents

ICSR Export with Signature

Signature Context in Exports

OTP Verification Workflow

Signature Image Guidelines

Recommended Specifications

Creating a Digital Signature

Security Considerations

Access Control

Data Protection

Audit Trail

Error Codes

Complete Example: Setting Up a Signature

ICSR Export

Document Management

Build docs developers (and LLMs) love

Authentication

ICSR

IPS Reports

Document Management

Surveillance

OCR & NLP

Products & MedDRA

​Introduction

​Base URL

​Authentication

​Get My Signature Profile

​Response

​Example Response

​Update Signature Profile

​Path Parameters

​Request Body

​Response

​Upload Signature Assets

​Path Parameters

​Request Parameters

​Response

​Storage

​Signature Usage in Documents

​ICSR Export with Signature

​Signature Context in Exports

​OTP Verification Workflow

​Signature Image Guidelines

​Recommended Specifications

​Creating a Digital Signature

​Security Considerations

​Access Control

​Data Protection

​Audit Trail

​Error Codes

​Complete Example: Setting Up a Signature

​Related Endpoints

ICSR Export

Document Management

Build docs developers (and LLMs) love

Introduction

Base URL

Authentication

Get My Signature Profile

Response

Example Response

Update Signature Profile

Path Parameters

Request Body

Response

Upload Signature Assets

Path Parameters

Request Parameters

Response

Storage

Signature Usage in Documents

ICSR Export with Signature

Signature Context in Exports

OTP Verification Workflow

Signature Image Guidelines

Recommended Specifications

Creating a Digital Signature

Security Considerations

Access Control

Data Protection

Audit Trail

Error Codes

Complete Example: Setting Up a Signature

Related Endpoints