File Query

POST

https://app.firmeasy.legal/api/v1/digital/archivo/consulta

File Query

This endpoint allows you to query a specific file within the Digital Signature flow. It is the main way to obtain the current details of the document using its identifier.

Authorization

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

Parameter	Type	Description	Limits
`Authorization`	string	Access token (Bearer token).	Obligatorio
`Content-Type`	string	Specifies the format of the request.	application/json

Authorization

string

Access token (Bearer token).

Limits:Obligatorio

Content-Type

string

Specifies the format of the request.

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 file identifier in JSON format to perform the query.

Parameter	Type	Description	Limits
`archivo_id`	string	Unique identifier (UUID) of the file you wish to query.	Obligatorio (Formato UUID)

archivo_id

string

Unique identifier (UUID) of the file you wish to query.

Limits:Obligatorio (Formato UUID)

Implementation Examples

cURL

curl -X POST [https://app.firmeasy.legal/api/v1/digital/archivo/consulta](https://app.firmeasy.legal/api/v1/digital/archivo/consulta) \
  -H "Authorization: Bearer TU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "archivo_id": "ad7e4811-bc1a-4b7f-a5c5-52aa144a3a86"
  }'

Node.js (Fetch)

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

const raw = JSON.stringify({
  "archivo_id": "ad7e4811-bc1a-4b7f-a5c5-52aa144a3a86"
});

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

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

Status Codes

Code	Status	Description
`200`	OK	Query executed successfully.
`400`	Bad Request	Invalid parameters or incorrect JSON format.
`401`	Unauthorized	Missing or invalid token.
`404`	Not Found	The file with the provided ID was not found.
`500`	Server Error	Internal server failure.