Saltar al contenido principal
GET
/
signing-requests
/
{id}
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.signingRequests.getSigningRequest({
    id: "id"
});
console.log(response);
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id} \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "sent": true,
    "finished": true,
    "cancelled": true,
    "declined": true,
    "expired": true
  },
  "template_description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "document_page_count": 2,
  "expiration_hours": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "credit_cost": 123,
  "timestamps": {
    "created_on": "2023-11-07T05:31:56Z",
    "sent_on": "2023-11-07T05:31:56Z",
    "finished_on": "2023-11-07T05:31:56Z",
    "cancelled_on": "2023-11-07T05:31:56Z",
    "declined_on": "2023-11-07T05:31:56Z",
    "last_changed_on": "2023-11-07T05:31:56Z",
    "last_signing_action_on": "2023-11-07T05:31:56Z"
  },
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "use_signing_order": true,
    "hand_drawn_only": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true,
    "require_otp_verification": null,
    "disable_guided_navigation": true,
    "allow_presigning_download": true,
    "show_qr_code": true,
    "identity_editable_fields": [
      "<string>"
    ],
    "notify_identity_change_email": false
  },
  "certificate": {
    "generated": true,
    "generated_on": "2023-11-07T05:31:56Z",
    "has_error": true
  },
  "final_document_download_url": "<string>",
  "document_only_download_url": "<string>",
  "certificate_only_download_url": "<string>"
}
{
  "error": "Unauthorized",
  "message": "Invalid API key"
}
{
  "error": "Not Found",
  "message": "The requested resource was not found"
}
{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

id
string<uuid>
requerido

Respuesta

Solicitud de Firma recuperada correctamente. Devuelve una estructura anidada detallada con status como un objeto y las marcas de tiempo agrupadas.

Solicitud de Firma detallada, tal como la devuelve GET /signing-requests/{id} (forma anidada con objeto status y timestamps)

id
string<uuid>
requerido

Identificador único de la Solicitud de Firma

name
string
requerido

Nombre de la Solicitud de Firma

companies_workspaces_id
string<uuid>
requerido

ID del Espacio de Trabajo al que pertenece esta Solicitud de Firma

status
object
requerido

Indicadores de estado (pueden ser true varios a la vez en estados terminales)

template_description
string | null

Descripción de la Plantilla

document_url
string<uri>

URL prefirmada al documento PDF

document_url_expires_at
string<date-time> | null
document_page_count
integer

Cantidad de páginas del documento

Rango requerido: x >= 1
expiration_hours
integer

Horas hasta que expira la Solicitud de Firma

expires_at
string<date-time> | null

Timestamp ISO 8601 de cuándo expira la Solicitud de Firma. Se calcula a partir de sent_on + expiration_hours. Es null si aún no se envió o si no se estableció expiration_hours.

credit_cost
integer

Créditos consumidos al enviarse

timestamps
object

Todos los timestamps relevantes del ciclo de vida de la Solicitud de Firma

settings
object

Configuración devuelta por los endpoints de listado y detalle de Solicitudes de Firma. Las Plantillas usan el esquema TemplateSettings (sin campos de identidad).

use_signing_order
enum<integer>
obsoleto
Opciones disponibles:
0,
1
allow_download
enum<integer>
obsoleto
Opciones disponibles:
0,
1
allow_editing_before_sending
enum<integer>
obsoleto
Opciones disponibles:
0,
1
hand_drawn_only
enum<integer>
obsoleto
Opciones disponibles:
0,
1
attach_pdf_on_finish
enum<integer>
obsoleto
Opciones disponibles:
0,
1
certificate
object | null

Información del estado de generación del certificado

final_document_download_url
string<uri> | null

URL firmada para descargar el documento final firmado (PDF con certificado). La URL expira después de 1 hora.

final_document_download_error
enum<string> | null
Opciones disponibles:
file_not_accessible,
null
document_only_download_url
string<uri> | null

URL firmada para descargar el PDF solo del documento. La URL expira después de 1 hora.

document_only_download_error
enum<string> | null
Opciones disponibles:
file_not_accessible,
null
certificate_only_download_url
string<uri> | null

URL firmada para descargar el PDF solo del certificado. La URL expira después de 1 hora.

certificate_only_download_error
enum<string> | null
Opciones disponibles:
file_not_accessible,
null