Registrar un rechazo externo

URL base: https://business.digito.do/api/v2.

EjemplosCopiar link al encabezado

Configura DIGITO_API_TOKEN en el servidor. Sustituye los IDs y archivos de ejemplo por los de tu equipo. TypeScript usa fetch y FormData de Node.js.

curl --fail-with-body \
  --request POST \
  --url 'https://business.digito.do/api/v2/envelope/recipient/501/reject' \
  --header "Authorization: $DIGITO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "envelopeId": "sobre_de_ejemplo",
  "reason": "El destinatario comunicó que necesita corregir sus datos."
}
JSON

Antes de empezarCopiar link al encabezado

• Esta operación registra un rechazo externo. No firma en nombre del destinatario ni reemplaza su autenticación.

AutenticaciónCopiar link al encabezado

Envía el token de la API en el encabezado Authorization. El acceso corresponde al equipo y a los permisos del token. Conserva el token en tu servidor.

Authorization: api_TU_TOKEN

Antes de cada acción de firma, el firmante debe autenticarse de nuevo con Digito ID. Una sesión previa de Business, un token de destinatario o un token de la API no sustituye este requisito.

ParámetrosCopiar link al encabezado

Cuerpo de la solicitudCopiar link al encabezado

El cuerpo es obligatorio.

Tipo de contenido: application/json.

Objeto de ejemploCopiar link al encabezado

{
  "envelopeId": "sobre_de_ejemplo",
  "reason": "El destinatario comunicó que necesita corregir sus datos."
}

Los valores muestran una solicitud posible; no son valores predeterminados del servidor.

{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "minLength": 1
    },
    "actAsEmail": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$"
    }
  },
  "required": [
    "envelopeId",
    "reason"
  ]
}

Respuesta de éxitoCopiar link al encabezado

En esta respuesta, el contrato deja positionX, positionY, width y height sin un tipo explícito. Los números del ejemplo son valores sintéticos; conserva la representación que devuelve la API y no deduzcas un tipo de respuesta a partir del ejemplo.

Este objeto sintético ilustra la estructura completa de una respuesta 200. Los identificadores, fechas, estados y tokens son datos de ejemplo.

{
  "envelopeId": "sobre_de_ejemplo",
  "role": "SIGNER",
  "readStatus": "NOT_OPENED",
  "signingStatus": "NOT_SIGNED",
  "sendStatus": "NOT_SENT",
  "id": 501,
  "email": "ana@example.com",
  "name": "Ana Ejemplo",
  "token": "token_de_destinatario_ejemplo",
  "documentDeletedAt": null,
  "expired": null,
  "expiresAt": null,
  "expirationNotifiedAt": null,
  "signedAt": null,
  "authOptions": null,
  "signingOrder": null,
  "signerCedula": null,
  "rejectionReason": null,
  "fields": [
    {
      "envelopeId": "sobre_de_ejemplo",
      "envelopeItemId": "archivo_de_ejemplo",
      "type": "SIGNATURE",
      "id": 701,
      "secondaryId": "field_secundario_de_ejemplo",
      "recipientId": 501,
      "page": 1,
      "positionX": 60,
      "positionY": 75,
      "width": 25,
      "height": 8,
      "customText": "valor_de_ejemplo",
      "inserted": false,
      "fieldMeta": null
    }
  ]
}

Respuestas y erroresCopiar link al encabezado

Los esquemas enlazados incluyen propiedades anidadas, campos obligatorios, variantes, enumeraciones, nulabilidad y restricciones. Consulta errores y reintentos para manejar respuestas no exitosas.

Identificador de operación: envelope-recipient-rejectOnBehalfOf.