Generate Folder Link

POST

https://app.firmeasy.legal/api/v1/digital/carpeta/enlace

Generate Folder Link

This endpoint allows you to generate a temporary link to provide access to a specific folder within the Digital Signature flow. It is ideal for securely sharing batches of documents with third parties.

Authorization

This resource is protected. You must include your access token in the request header.

Parameter	Type	Description	Limits
`Authorization`	string	Access token obtained in the login process, preceded by the word 'Bearer'.	Obligatorio
`Content-Type`	string	Specifies the format of the request body.	application/json

Authorization

string

Access token obtained in the login process, preceded by the word 'Bearer'.

Limits:Obligatorio

Content-Type

string

Specifies the format of the request body.

Limits:application/json

Request Parameters

Required Fields

Fields marked with an asterisk (*) are required and must be provided in the request. Other fields are optional.

Send the following parameters in the body of your POST request in JSON format.

Parameter	Type	Description	Limits
`carpeta_id`	string	Token or unique identifier (UUID) of the folder you wish to share.	Obligatorio (Formato UUID)
`tiempo`	integer	Validity or expiration time of the generated link.	Obligatorio (Número entero)

carpeta_id

string

Token or unique identifier (UUID) of the folder you wish to share.

Limits:Obligatorio (Formato UUID)

tiempo

integer

Validity or expiration time of the generated link.

Limits:Obligatorio (Número entero)

Implementation Examples

Here are the code snippets ready to test the link generation.

cURL

curl -X POST [https://app.firmeasy.legal/api/v1/digital/carpeta/enlace](https://app.firmeasy.legal/api/v1/digital/carpeta/enlace) \
  -H "Authorization: Bearer TU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "carpeta_id": "59288b30-0305-40c6-90f4-d6da2d9750ce",
    "tiempo": 5
  }'

Node.js (Fetch)

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer TU_TOKEN_AQUI");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "carpeta_id": "59288b30-0305-40c6-90f4-d6da2d9750ce",
  "tiempo": 5
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("[https://app.firmeasy.legal/api/v1/digital/carpeta/enlace](https://app.firmeasy.legal/api/v1/digital/carpeta/enlace)", requestOptions)
  .then((response) => response.json())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Response Structure

Note for the Development Team: The JSON structure of the successful response (200 OK) for this endpoint is pending an update in the official documentation.

Nombre	Type	Description
`url_enlace`	string	[Reference structure] The temporary link generated to access the folder.

url_enlace

string

[Reference structure] The temporary link generated to access the folder.

Status Codes

Code	Status	Description
`200`	OK	The temporary link was generated successfully.
`400`	Bad Request	The parameters sent do not have the correct format (e.g. `tiempo` is not a number).
`401`	Unauthorized	The token was not sent or has expired.
`404`	Not Found	The folder with the provided ID was not found.
`500`	Server Error	Internal server failure at Firmeasy.