ByDomuDevelopers
Crear clave

Detalle de sobre de firma

GEThttps://api.bydomu.com/v1/envelopes/{id}

El sobre con su documento, sus campos y el estado de cada destinatario. Las fotos de verificación (selfie y documento de identidad) llegan como URLs firmadas de lectura temporal.

Permiso
documents:read
Claves
Solo secreta (desde un servidor)

Encabezados

X-API-Keystringobligatorio
Tu clave secreta.

Parámetros de ruta

idstringobligatorio
ID del sobre

Respuestas

200El sobre
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
404NOT_FOUND · El recurso no existe en la organización.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/envelopes/clx1env001" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/envelopes/clx1env001", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/envelopes/clx1env001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Respuesta · 200 · ejemplo
{
  "data": {
    "id": "clx1env001",
    "name": "Contrato de arrendamiento - Apto 301",
    "status": "DRAFT",
    "signingMode": "SEQUENTIAL",
    "expiresAt": "2026-10-30T23:59:59.000Z",
    "completedAt": "2026-09-22T15:10:00.000Z",
    "createdAt": "2026-09-15T09:00:00.000Z",
    "updatedAt": "2026-09-22T15:10:00.000Z",
    "deal": {
      "id": "clx1deal002",
      "title": "Arriendo Apto 301"
    },
    "createdBy": {
      "firstName": "Carlos",
      "lastName": "Rodríguez"
    },
    "subject": "Firma del contrato",
    "message": "Adjunto el contrato para tu firma.",
    "documentHtml": "<h1>Contrato de arrendamiento</h1>…",
    "documentPdfUrl": "https://cdn.bydomu.com/envelopes/clx1env001.pdf",
    "documentHash": "9f86d081884c7d65…",
    "requireSelfie": false,
    "requireEmailOtp": true,
    "requireIdDocument": false,
    "fields": [
      {
        "id": "clx1fld001",
        "type": "SIGNATURE",
        "recipientId": "clx1rcp001"
      }
    ],
    "recipients": [
      {
        "id": "clx1rcp001",
        "name": "María González",
        "email": "[email protected]",
        "role": "SIGNER",
        "order": 1,
        "status": "PENDING",
        "signedAt": "2026-09-22T15:10:00.000Z",
        "signerIp": "181.49.10.2",
        "otpVerified": true,
  …

La clave va en la variable BYDOMU_API_KEY. Los datos del ejemplo no son de ninguna inmobiliaria.