Autosign API Reference (1.0)

Download OpenAPI specification:Download

transaction_created Webhook

Request Body schema: application/json

Evento que se emite cuando se crea una transacción

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "transaction_created" El tipo de evento
required	object La información del evento

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T17:02:20.635Z",
"id": "clsowe02k00063ol92j9sjwdp",
"type": "transaction_created",
"data": {"id": "clsowe02i00053ol94bo3wl1q",
"status": "draft",
"created_by": {"email": "dev@autosign.io",
"id": "clrjofqx40001raun4msulwp8"
}
}
}

transaction_started Webhook

Request Body schema: application/json

Evento que se emite cuando una transacción fue iniciada

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "transaction_started" El tipo de evento
required	object La información del evento

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T17:38:55.563Z",
"id": "clsoxp1os0004105mtsl2cg22",
"type": "transaction_started",
"data": {"started_by": {"id": "clrjofqx40001raun4msulwp8",
"email": "dev@autosign.io"
},
"id": "clsoxls930005exxdrxiuc5to",
"status": "started"
}
}

transaction_completed Webhook

Request Body schema: application/json

Evento que se emite cuando una transacción fue completada

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "transaction_completed" El tipo de evento
required	object La información del evento

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T17:12:25.144Z",
"id": "clsowr00e000hgzu3dmmwasq5",
"type": "transaction_completed",
"data": {"id": "clsowfhnx000c3ol9gtwp3wcl",
"status": "completed",
"recipients": [{"email": "dev@autosign.io",
"id": "clsowjov50000mq586zyohd3p",
"name": "Luciano Alvarez",
"role": "sender",
"submitted_at": "2024-02-16T17:09:57.353Z"
},
{"email": "lucianoalvarez1212@gmail.com",
"id": "clsowjov50001mq58fn2a659u",
"name": "Another firmante",
"role": "signer",
"submitted_at": "2024-02-16T17:12:22.692Z"
}
],
"sealed_documents": [{"created_at": "2024-02-16T17:12:25.125Z",
"document": {"id": "clsowjaxa000g3ol9ok4ealw3",
"name": "sample.pdf"
},
"id": "clsowqyhy000agzu3jm80ihoh",
"name": "sealed-sample.pdf",
"url": "https://s3.autosign-private.amazonaws.com/1fb0dd38-1fc1-4b6e-a3fc-00b82b8cfce1-sealed-sample.pdf?AWSAccessKeyId=AKIASZTRMMJUKCZ66QEL&Expires=1708107147&Signature=wRPexWUm15ALZqcC3SazCHNZ00Q%3D"
}
]
}
}

transaction_expired Webhook

Request Body schema: application/json

Evento que se emite cuando una transacción fue expirada

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "transaction_expired" El tipo de evento
required	object La información del evento

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T18:11:20.743Z",
"id": "clsoyuqlm0002gjd9d0erwubq",
"type": "transaction_expired",
"data": {"id": "clsoy7hh70005bt77pasujcpy",
"status": "expired",
"expiration_days": null,
"expired_at": "2024-02-16T18:11:20.736Z"
}
}

recipient_submitted Webhook

Request Body schema: application/json

Evento que se emite cuando un destinatario ha realizado las acciones necesarias en la transacción

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "recipient_submitted" El tipo de evento
required	object

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T17:12:20.159Z",
"id": "clsowqwm90001gzu3qpjfpmeh",
"type": "recipient_submitted",
"data": {"id": "clsowfhnx000c3ol9gtwp3wcl",
"status": "started",
"recipient": {"email": "lucianoalvarez1212@gmail.com",
"id": "clsowjov50001mq58fn2a659u",
"name": "Another firmante",
"role": "signer",
"submitted_at": "2024-02-16T17:12:20.159Z"
}
}
}

transaction_rejected Webhook

Request Body schema: application/json

Evento que se emite cuando un destinatario ha rechazado una transacción

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "transaction_rejected" El tipo de evento
required	object

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T17:41:26.268Z",
"id": "clsoxs9z3000s105mqswgw0im",
"type": "transaction_rejected",
"data": {"id": "clsoxls930005exxdrxiuc5to",
"status": "rejected",
"rejected_by": {"email": "lucianoalvarez1212@gmail.com",
"id": "clsoxovjt0001vj584ds8gmmh",
"name": "Luciano Alvarez",
"role": "proxy"
}
}
}

transaction_cancelled Webhook

Request Body schema: application/json

Evento que se emite cuando una transacción fue cancelada por el remitente u otro usuario de la compañía

created required	string <date-time> La fecha en la que se creó el evento
id required	string El id del evento
type required	string Value: "transaction_cancelled" El tipo de evento
required	object La información del evento

Request samples

Payload

Content type

application/json

{"created": "2024-02-16T18:11:20.743Z",
"id": "clsoyuqlm0002gjd9d0erwubq",
"type": "transaction_cancelled",
"data": {"id": "clsoy7hh70005bt77pasujcpy",
"status": "expired",
"cancelled_reason": "Campos incorrectos en el documento",
"cancelled_at": "2024-02-16T18:11:20.736Z"
}
}

File

Subir archivo

Este endpoint te permite subir un archivo y obtener un token que representa dicho archivo dentro del cloud storage de autosign. El token retornado puede ser usado en otros endpoints al momento de vincular archivos con otros recursos (transacciones, plantillas) Se soportan todos los archivos con un peso máximo de 10 MB.

Request Body schema: multipart/form-data
required

name	string Nombre del archivo
file	string <binary> Archivo a subir. Máximo 10MB

Responses

Response samples

Content type

application/json

{"presigned_url": "https://autosign-private.s3.amazonaws.com/cd99b1bd-4451-49ea-b72b-d1d679851d56-example.pdf?AWSAccessKeyId=AKIASZTRMMJUN2TKNHWH&Expires=1706207887&Signature=Eq%2BGiaC12OBKJYcLTpoUSxDv4Fs%3D",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Transaction

Crear transacción

Crea una transacción en estado borrador

Authorizations:

oauth2

Request Body schema: application/json
required

name	string Nombre de la transacción
notification_endpoint	string or null <uri> <= 255 characters Endpoint en donde autosign enviara actualizaciones sobre la transacción (Instant Transaction Notification)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"notification_endpoint": "http://example.com"
}

Response samples

Content type

application/json

{"id": "string"
}

Actualizar campos

Actualiza los campos de los documentos de la transacción

Authorizations:

oauth2

path Parameters

transactionId

required

string

ID de la transacción

Request Body schema: application/json
required

required

Array of objects

Lista de campos

Array

guid	string or null <= 30 characters Id opcional generado por el cliente para permitir hacer referencia al campo
document_id required	string <cuid> non-empty Id del documento
recipient_id required	string <cuid> non-empty Id del destinatario
width required	number [ 0 .. 100 ] Ancho del campo en porcentaje relativo a las dimensiones de la página
height required	number [ 0 .. 100 ] Alto del campo en porcentaje relativo a las dimensiones de la página
positionX required	number [ 0 .. 100 ] Posición horizontal del campo en porcentaje relativo a las dimensiones de la página
positionY required	number [ 0 .. 100 ] Posición vertical del campo en porcentaje relativo a las dimensiones de la página
page required	number >= 0 Número de página
required	string or string Etiqueta del campo
type required	string Enum: "email" "select" "checkbox" "text" "number" "signature" "initials" "signature_date" "company_name" "person_name" "textarea" Tipo de campo
font_family required	string Enum: "roboto" "space_grotesk" "barlow_condensed" "ibm_plex_sans_condensed" "playfair_display" "roboto_condensed" "roboto_mono" "space_mono" "helvetica" Tipo de fuente
bold	boolean Default: false Indica si el texto tiene que tener el estilo negrita
italic	boolean Default: false Indica si el texto tiene que tener el estilo cursiva
underline	boolean Default: false Indica si el texto tiene que tener un subrayado
font_size required	number Tamaño de fuente
font_color required	string^#[0-9a-f]{3,6}$ Color de fuente. Unicamente se acepta el formato hexadecimal
required	string or string Texto de ayuda
is_required required	boolean Indica si el campo es requerido
min_length	number,null or null [ 0 .. 2147483647 ] Longitud mínima del campo. Solo aplica para campos de texto
max_length	number,null or null [ 0 .. 2147483647 ] Longitud máxima del campo. Solo aplica para campos de texto
min_value	number,null or null [ 0 .. 2147483647 ] Valor mínimo del campo. Solo aplica para campos numéricos
max_value	number,null or null [ 0 .. 2147483647 ] Valor máximo del campo. Solo aplica para campos numéricos
	(,null or null) or (,null or null) Expresión regular para validar el campo. Solo aplica para campos de texto
	Array of objects Default: [] Opciones para campos de selección
signature_field_id_to_record_date	string or null Referencia al campo de firma que se debe registrar la fecha

Responses

Request samples

Payload

Content type

application/json

{"fields": [{"document_id": "clsqnztew000arhzv2b0b5lr7",
"page": 0,
"height": 5.14,
"width": 20.78,
"positionX": 63.71,
"positionY": 8.56,
"type": "signature",
"label": "Firma",
"recipient_id": "clsqo03aw0000yq58budq7b7a",
"id": "kqLsau9XTPwjhgkP4kISP",
"italic": false,
"is_required": true,
"bold": false,
"font_family": "roboto",
"font_size": 14,
"font_color": "#000000",
"helper_text": ""
}
]
}

Actualizar transacción

Actualiza información relacionada a la transacción

Authorizations:

oauth2

path Parameters

transactionId

required

string

ID de la transacción

Request Body schema: application/json
required

edit_navigation	boolean,null or null Configura si el usuario podrá acceder al editor previo a enviar la transacción
required	Array of objects non-empty Documentos de la transacción
	(string or null) or string Alias que se usara en el correo de invitación de firma
name required	string [ 1 .. 255 ] characters Nombre de la transacción
description	string Descripción de la transacción
	(string or null) or string Contenido se usara en el correo de invitación de firma
	(string or null) or string Asunto se usara en el correo de invitación de firma
expiration_days	integer,null or null
required	Array of objects non-empty

Responses

Request samples

Payload

Content type

application/json

{"edit_navigation": true,
"documents": [{"index": 0,
"id": "clsqwmlwd0041lgn3c298zc5l",
"isLoading": false
}
],
"email_alias": "",
"name": "MY SAMPLE PDF",
"description": "",
"email_body": "",
"email_subject": "",
"recipients": [{"id": "clsqwmefn003ulgn3mkxt14fk",
"role": "sender",
"color": "pink",
"index": 0,
"name": "Luciano Alvarez",
"email": "dev@autosign.io"
},
{"id": "_-yyQ1lLsPUEx6L017xC_",
"role": "signer",
"color": "slate",
"index": 1,
"name": "Another User",
"email": "johndoe@gmail.com"
}
],
"fields": [ ]
}

Detalle de transacción

Obtener el detalle de una transacción

Authorizations:

oauth2

path Parameters

transactionId

required

string

ID de la transacción

Responses

Response samples

Content type

application/json

{"id": "clsqlgnij000fjele82l3lxz2",
"template_id": "clsqlgnie000cjelecsv1hfrm",
"created_at": "2024-02-17T21:32:00.901Z",
"updated_at": "2024-02-17T21:32:00.901Z",
"created_by_id": "clrjofqx40001raun4msulwp8",
"sender_id": "clrjofqx40001raun4msulwp8",
"provider_type": "onespan",
"provider_id": null,
"is_provider_ready": false,
"expiration_days": null,
"rejected_reason": null,
"rejected_at": null,
"rejected_by_id": null,
"completed_at": null,
"sent_at": null,
"expires_at": null,
"status": "draft",
"company_id": "clrjofqx20000rauna08xwd42",
"is_sealed": false,
"is_archived": false,
"expired_at": null,
"template": {"id": "clsqlgnie000cjelecsv1hfrm",
"name": "Plantilla de prueba onboarding Cris + INTERMEDIARIO",
"description": "",
"created_by_id": "clrjofqx40001raun4msulwp8",
"edit_navigation": true,
"reusable": false,
"email_alias": "",
"email_subject": "",
"email_body": "",
"created_at": "2024-02-17T21:32:00.901Z",
"updated_at": "2024-02-17T21:32:12.560Z",
"company_id": "clrjofqx20000rauna08xwd42",
"fields": [{"id": "clsqlgwi9000kjelelrfe5usq",
"document_id": "clrozh35o00088ry5q4uj8i3c",
"recipient_id": "clsqlgwi40000if58145eaveg",
"width": 28.01,
"height": 6.34,
"positionX": 12,
"positionY": 49.77,
"page": 0,
"label": "Nombre de la persona",
"type": "person_name",
"template_id": "clsqlgnie000cjelecsv1hfrm",
"font_family": "roboto",
"bold": false,
"italic": false,
"underline": false,
"font_size": 14,
"font_color": "#000000",
"helper_text": "",
"is_required": false,
"max_length": null,
"min_length": null,
"max_value": null,
"min_value": null,
"regex": null,
"options": [ ]
}
],
"recipients": [{"id": "clsqlgwi40000if58145eaveg",
"name": "",
"email": "",
"color": "stone",
"token": null,
"role": "sender",
"submitted_at": null,
"index": 0,
"is_current": false,
"created_at": "2024-02-17T21:32:12.560Z",
"updated_at": "2024-02-17T21:32:12.560Z"
},
{"id": "clsqlgwi40001if58f1a726yz",
"name": "",
"email": "",
"color": "indigo",
"token": null,
"role": "signer",
"submitted_at": null,
"index": 1,
"is_current": false,
"created_at": "2024-02-17T21:32:12.560Z",
"updated_at": "2024-02-17T21:32:12.560Z"
},
{"id": "clsqlgwi40002if58fvcc47y2",
"name": "",
"email": "",
"color": "zinc",
"token": null,
"role": "signer",
"submitted_at": null,
"index": 2,
"is_current": false,
"created_at": "2024-02-17T21:32:12.560Z",
"updated_at": "2024-02-17T21:32:12.560Z"
}
],
"documents": [{"file": {"id": "clrozh35p000a8ry57o8frjiw",
"original_name": "2020-08-27T00-35_transaccin_n._3214998911948606-6170100.pdf",
"stored_name": "d0a67218-f103-4f4b-b10c-d42354773a77-2020-08-27t00-35_transaccin_n._3214998911948606-6170100.pdf",
"url": "http://localhost:4566/autosign/d0a67218-f103-4f4b-b10c-d42354773a77-2020-08-27t00-35_transaccin_n._3214998911948606-6170100.pdf?AWSAccessKeyId=AKIASZTRMMJUKCZ66QEL&Expires=1708291932&Signature=WdwLVbqtwu2tI81iRnOXAkvDfcA%3D"
},
"status": "processed",
"id": "clrozh35o00088ry5q4uj8i3c",
"index": 0,
"pages": [{"document_id": "clrozh35o00088ry5q4uj8i3c",
"id": "clrozh5f4000sv7tnt6u7ro99",
"file": {"id": "clrozh5ep000rv7tnx5nggbst",
"original_name": "documents/clrozh35o00088ry5q4uj8i3c/0.jpeg",
"stored_name": "documents/clrozh35o00088ry5q4uj8i3c/0.jpeg",
"url": "http://localhost:4566/autosign/documents/clrozh35o00088ry5q4uj8i3c/0.jpeg?AWSAccessKeyId=AKIASZTRMMJUKCZ66QEL&Expires=1708291932&Signature=xhPiSQ3u7uSszRWHJz7JyqKhEIA%3D"
}
}
]
}
]
}
}

Agregar documento

Agregar un archivo previamente subido al cloud storage de autosign como documento de una transacción

Authorizations:

oauth2

path Parameters

transactionId

required

string

ID de la transacción

Request Body schema: application/json
required

token

required

string non-empty

File token del archivo. Para subir un archivo al cloudstorage de autosign y obtener uno, observa la documentación sobre File

Responses

Request samples

Payload

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Response samples

Content type

application/json

{"id": "clsoy7hh70005bt77pasujcpy"
}

Eliminar documento

Eliminar un documento previamente asociado a la transacción

Authorizations:

oauth2

path Parameters

documentId required	string ID del documento
transactionId required	string ID de la transacción

Responses

Usar plantillas

Instancia una o varias plantillas para la transacción

Authorizations:

oauth2

path Parameters

transactionId

required

string

ID de la transacción

Request Body schema: application/json
required

required

Array of objects non-empty

Lista de plantillas

Array (non-empty)

required

string non-empty

ID de la plantilla

Responses

Request samples

Payload

Content type

application/json

{"templates": [{"id": "cjuwz3z5z0000l3z1z3z3z3z3"
}
]
}

Response samples

Content type

application/json

{"id": "clsqlgnij000fjele82l3lxz2",
"template_id": "clsqlgnie000cjelecsv1hfrm",
"created_at": "2024-02-17T21:32:00.901Z",
"updated_at": "2024-02-17T21:32:00.901Z",
"created_by_id": "clrjofqx40001raun4msulwp8",
"sender_id": "clrjofqx40001raun4msulwp8",
"provider_type": "onespan",
"provider_id": null,
"is_provider_ready": false,
"expiration_days": null,
"rejected_reason": null,
"rejected_at": null,
"rejected_by_id": null,
"completed_at": null,
"sent_at": null,
"expires_at": null,
"status": "draft",
"company_id": "clrjofqx20000rauna08xwd42",
"is_sealed": false,
"is_archived": false,
"expired_at": null,
"template": {"id": "clsqlgnie000cjelecsv1hfrm",
"name": "Plantilla de prueba onboarding Cris + INTERMEDIARIO",
"description": "",
"created_by_id": "clrjofqx40001raun4msulwp8",
"edit_navigation": true,
"reusable": false,
"email_alias": "",
"email_subject": "",
"email_body": "",
"created_at": "2024-02-17T21:32:00.901Z",
"updated_at": "2024-02-17T21:32:12.560Z",
"company_id": "clrjofqx20000rauna08xwd42",
"fields": [{"id": "clsqlgwi9000kjelelrfe5usq",
"document_id": "clrozh35o00088ry5q4uj8i3c",
"recipient_id": "clsqlgwi40000if58145eaveg",
"width": 28.01,
"height": 6.34,
"positionX": 12,
"positionY": 49.77,
"page": 0,
"label": "Nombre de la persona",
"type": "person_name",
"template_id": "clsqlgnie000cjelecsv1hfrm",
"font_family": "roboto",
"bold": false,
"italic": false,
"underline": false,
"font_size": 14,
"font_color": "#000000",
"helper_text": "",
"is_required": false,
"max_length": null,
"min_length": null,
"max_value": null,
"min_value": null,
"regex": null,
"options": [ ]
}
],
"recipients": [{"id": "clsqlgwi40000if58145eaveg",
"name": "",
"email": "",
"color": "stone",
"token": null,
"role": "sender",
"submitted_at": null,
"index": 0,
"is_current": false,
"created_at": "2024-02-17T21:32:12.560Z",
"updated_at": "2024-02-17T21:32:12.560Z"
},
{"id": "clsqlgwi40001if58f1a726yz",
"name": "",
"email": "",
"color": "indigo",
"token": null,
"role": "signer",
"submitted_at": null,
"index": 1,
"is_current": false,
"created_at": "2024-02-17T21:32:12.560Z",
"updated_at": "2024-02-17T21:32:12.560Z"
},
{"id": "clsqlgwi40002if58fvcc47y2",
"name": "",
"email": "",
"color": "zinc",
"token": null,
"role": "signer",
"submitted_at": null,
"index": 2,
"is_current": false,
"created_at": "2024-02-17T21:32:12.560Z",
"updated_at": "2024-02-17T21:32:12.560Z"
}
],
"documents": [{"file": {"id": "clrozh35p000a8ry57o8frjiw",
"original_name": "2020-08-27T00-35_transaccin_n._3214998911948606-6170100.pdf",
"stored_name": "d0a67218-f103-4f4b-b10c-d42354773a77-2020-08-27t00-35_transaccin_n._3214998911948606-6170100.pdf",
"url": "http://localhost:4566/autosign/d0a67218-f103-4f4b-b10c-d42354773a77-2020-08-27t00-35_transaccin_n._3214998911948606-6170100.pdf?AWSAccessKeyId=AKIASZTRMMJUKCZ66QEL&Expires=1708291932&Signature=WdwLVbqtwu2tI81iRnOXAkvDfcA%3D"
},
"status": "processed",
"id": "clrozh35o00088ry5q4uj8i3c",
"index": 0,
"pages": [{"document_id": "clrozh35o00088ry5q4uj8i3c",
"id": "clrozh5f4000sv7tnt6u7ro99",
"file": {"id": "clrozh5ep000rv7tnx5nggbst",
"original_name": "documents/clrozh35o00088ry5q4uj8i3c/0.jpeg",
"stored_name": "documents/clrozh35o00088ry5q4uj8i3c/0.jpeg",
"url": "http://localhost:4566/autosign/documents/clrozh35o00088ry5q4uj8i3c/0.jpeg?AWSAccessKeyId=AKIASZTRMMJUKCZ66QEL&Expires=1708291932&Signature=xhPiSQ3u7uSszRWHJz7JyqKhEIA%3D"
}
}
]
}
]
}
}

Empezar transacción

Empieza una transacción. Este método modifica el estado actual de la transacción a empezado.

Authorizations:

oauth2

path Parameters

transactionId

required

string

ID de la transacción

Responses

Response samples

Content type

application/json

{"url": "https://app.autosign.io/sign/clsqlgnij000fjele82l3lxz2?token=clsqlgnij000fjele82l3lxz2clsqlgnij000fjele82l3lxz2clsqlgnij000fjele82l3lxz2"
}

Template

Listar plantillas

Lista las plantillas de transacciones

Authorizations:

oauth2

query Parameters

search	string Búsqueda por nombre de plantilla
limit required	number Cantidad de plantillas a mostrar
page required	number Número de página

Responses

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string"
}
],
"meta": {"limit": 0,
"is_first_page": true,
"is_last_page": true,
"current_page": 0,
"previous_page": 0,
"next_page": 0,
"page_count": 0
}
}

OAuth

Exchange code for access token

Request Body schema: application/json
required

client_id required	string non-empty OAuth Application Client ID
client_secret required	string non-empty OAuth Application Client Secret
code required	string non-empty Authorization code

Responses

Request samples

Payload

Content type

application/json

{"client_id": "string",
"client_secret": "string",
"code": "string"
}

Response samples

default

Content type

application/json

{"access_token": "string",
"refresh_token": "string",
"expires_in": 0
}

Refresh access token

Request Body schema: application/json
required

client_id required	string non-empty OAuth Application Client ID
client_secret required	string non-empty OAuth Application Client Secret
refresh_token required	string non-empty Refresh token

Responses

Request samples

Payload

Content type

application/json

{"client_id": "string",
"client_secret": "string",
"refresh_token": "string"
}

Response samples

default

Content type

application/json

{"access_token": "string",
"expires_in": 0
}

Webhook

Crear webhook

Este endpoint te permite crear un webhook

Authorizations:

oauth2

Request Body schema: application/json
required

name required	string [ 1 .. 255 ] characters Nombre del webhook
endpoint required	string <uri> non-empty URL del webhook. Debe ser segura (TLS)
events required	Array of strings non-empty Items Enum: "transaction_completed" "transaction_created" "transaction_started" "transaction_expired" "transaction_rejected" "recipient_submitted" "transaction_cancelled" La lista de eventos que deseas suscribirte

Responses

Request samples

Payload

Content type

application/json

{"name": "Webhook de prueba",
"endpoint": "https://example.com/webhook",
"events": ["transaction_created",
"transaction_started"
]
}

Response samples

Content type

application/json

{"id": "cjuv0v7zg0000hj6z8f0z3x4z"
}

Listar webhooks

Este endpoint te permite listar los webhooks mediante paginacion

Authorizations:

oauth2

query Parameters

limit required	number Example: limit=10 Numero de elementos por pagina
page required	number Example: page=1 Numero de pagina

Responses

Response samples

Content type

application/json

{"items": [{"name": "Webhook de prueba",
"events": ["transaction_started",
"transaction_completed"
],
"enabled": true,
"endpoint": "https://example.com/webhook",
"id": "cjuv0v7zg0000hj6z8f0z3x4z"
}
],
"meta": {"limit": 10,
"is_first_page": true,
"is_last_page": true,
"current_page": 1,
"previous_page": null,
"next_page": null,
"page_count": 1
}
}

Eliminar webhook

Este endpoint te permite eliminar un webhook creado

Authorizations:

oauth2

path Parameters

webhookId

required

any

Identificador del webhook

Autosign API Reference (1.0)

transaction_created Webhook

Request Body schema: application/json

Request samples

transaction_started Webhook

Request Body schema: application/json

Request samples

transaction_completed Webhook

Request Body schema: application/json

Request samples

transaction_expired Webhook

Request Body schema: application/json

Request samples

recipient_submitted Webhook

Request Body schema: application/json

Request samples

transaction_rejected Webhook

Request Body schema: application/json

Request samples

transaction_cancelled Webhook

Request Body schema: application/json

Request samples

File

Subir archivo

Request Body schema: multipart/form-datarequired

Responses

Response samples

Transaction

Crear transacción

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Actualizar campos

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Actualizar transacción

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Detalle de transacción

Authorizations:

path Parameters

Responses

Response samples

Agregar documento

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Eliminar documento

Authorizations:

path Parameters

Responses

Usar plantillas

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Empezar transacción

Authorizations:

path Parameters

Responses

Response samples

Template

Listar plantillas

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required