Exportar datos de verificación a documento personalizado con variables de apoderados

curl --request POST \
  --url https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key_people": [
    {
      "key": "key_person_1",
      "person_id": 10,
      "role_id": "role_123"
    },
    {
      "key": "key_person_2",
      "person_id": 15,
      "role_id": "role_456"
    }
  ]
}
'

import requests

url = "https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}"

payload = { "key_people": [
        {
            "key": "key_person_1",
            "person_id": 10,
            "role_id": "role_123"
        },
        {
            "key": "key_person_2",
            "person_id": 15,
            "role_id": "role_456"
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key_people: [
      {key: 'key_person_1', person_id: 10, role_id: 'role_123'},
      {key: 'key_person_2', person_id: 15, role_id: 'role_456'}
    ]
  })
};

fetch('https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-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.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key_people' => [
        [
                'key' => 'key_person_1',
                'person_id' => 10,
                'role_id' => 'role_123'
        ],
        [
                'key' => 'key_person_2',
                'person_id' => 15,
                'role_id' => 'role_456'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}"

	payload := strings.NewReader("{\n  \"key_people\": [\n    {\n      \"key\": \"key_person_1\",\n      \"person_id\": 10,\n      \"role_id\": \"role_123\"\n    },\n    {\n      \"key\": \"key_person_2\",\n      \"person_id\": 15,\n      \"role_id\": \"role_456\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key_people\": [\n    {\n      \"key\": \"key_person_1\",\n      \"person_id\": 10,\n      \"role_id\": \"role_123\"\n    },\n    {\n      \"key\": \"key_person_2\",\n      \"person_id\": 15,\n      \"role_id\": \"role_456\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key_people\": [\n    {\n      \"key\": \"key_person_1\",\n      \"person_id\": 10,\n      \"role_id\": \"role_123\"\n    },\n    {\n      \"key\": \"key_person_2\",\n      \"person_id\": 15,\n      \"role_id\": \"role_456\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "File generated successfully. Download URL provided.",
  "download_url": "https://www.gotrebol.com/download/file.pdf",
  "expiresIn": 3600000,
  "size": 1000000
}

Exportación de Verificaciones

Exportar datos de verificación a documento personalizado con variables de apoderados

Exporta los datos de una verificación a un documento personalizado (PDF o Word) reemplazando los IDs con la información extraída, incluyendo el mapeo de variables de apoderados.

Este endpoint permite especificar qué personas y roles se deben usar para llenar las variables de apoderados en la plantilla. Las variables en la plantilla deben usar la nomenclatura {key_person_#} donde # es un número (ej: {key_person_1}, {key_person_2}).

Funcionalidad:

Genera un diccionario de variables únicas a partir de la información extraída
Reemplaza los IDs en el documento con la información correspondiente
Mapea las variables de apoderados ({key_person_#}) con las personas y roles especificados en el body
Retorna el documento procesado con los datos actualizados

Obtener IDs de personas y roles: Los valores de person_id y role_id se pueden obtener del endpoint Obtener sección por ID de verificación bajo la sección /people:

person_id: Se obtiene del campo people_id en cada objeto del array key_people
role_id: Se obtiene del campo id en cada objeto del array roles dentro de cada elemento de key_people

Tipos de documentos soportados: PDF, Word (.docx)

POST

verifications

{verification-id}

export

{doc-template-id}

Exportar datos de verificación a documento personalizado con variables de apoderados

curl --request POST \
  --url https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key_people": [
    {
      "key": "key_person_1",
      "person_id": 10,
      "role_id": "role_123"
    },
    {
      "key": "key_person_2",
      "person_id": 15,
      "role_id": "role_456"
    }
  ]
}
'

import requests

url = "https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}"

payload = { "key_people": [
        {
            "key": "key_person_1",
            "person_id": 10,
            "role_id": "role_123"
        },
        {
            "key": "key_person_2",
            "person_id": 15,
            "role_id": "role_456"
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key_people: [
      {key: 'key_person_1', person_id: 10, role_id: 'role_123'},
      {key: 'key_person_2', person_id: 15, role_id: 'role_456'}
    ]
  })
};

fetch('https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-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.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key_people' => [
        [
                'key' => 'key_person_1',
                'person_id' => 10,
                'role_id' => 'role_123'
        ],
        [
                'key' => 'key_person_2',
                'person_id' => 15,
                'role_id' => 'role_456'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}"

	payload := strings.NewReader("{\n  \"key_people\": [\n    {\n      \"key\": \"key_person_1\",\n      \"person_id\": 10,\n      \"role_id\": \"role_123\"\n    },\n    {\n      \"key\": \"key_person_2\",\n      \"person_id\": 15,\n      \"role_id\": \"role_456\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key_people\": [\n    {\n      \"key\": \"key_person_1\",\n      \"person_id\": 10,\n      \"role_id\": \"role_123\"\n    },\n    {\n      \"key\": \"key_person_2\",\n      \"person_id\": 15,\n      \"role_id\": \"role_456\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gotrebol.com/v2/verifications/{verification-id}/export/{doc-template-id}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key_people\": [\n    {\n      \"key\": \"key_person_1\",\n      \"person_id\": 10,\n      \"role_id\": \"role_123\"\n    },\n    {\n      \"key\": \"key_person_2\",\n      \"person_id\": 15,\n      \"role_id\": \"role_456\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "File generated successfully. Download URL provided.",
  "download_url": "https://www.gotrebol.com/download/file.pdf",
  "expiresIn": 3600000,
  "size": 1000000
}

Authorizations

x-api-key

string

header

required

Path Parameters

verification-id

string

required

El ID único de la verificación

doc-template-id

string

required

El ID de la plantilla de documento. Ver plantillas de documentos.

Body

application/json

key_people

object[]

required

Array de objetos que mapean variables de apoderados en la plantilla con personas y roles específicos.

Show child attributes

Response

JSON con la url de descarga del archivo y otros datos adicionales.

success

boolean

Booleano que indica si la exportación fue exitosa.

Example:

true

message

string

Mensaje de éxito.

Example:

"File generated successfully. Download URL provided."

download_url

string

URL de descarga del archivo. Al acceder a ella se descargará el archivo automáticamente.

Example:

"https://www.gotrebol.com/download/file.pdf"

expires_in

number

Tiempo de expiración del enlace en milisegundos(1 hora).

Example:

3600000

size

number

Tamaño del archivo en bytes.

Example:

1000000

Exportar datos de verificación a documento personalizado Actualizar labels de una verificacion

⌘I

Leer información de la empresa

Creacion de Verificacion

Gestion de item Ids

Invalidar un documento

Exportación de Verificaciones

Labels de Verificacion

Actualizar personas clave de una verificacion

Agregar items a una verificacion

Estado de validacion de documentos

Gestión de Flujos de Cuenta

Gestión de Esquemas de Formularios

Gestión de IPs Permitidas

Gestión de API Keys

Gestión de Política de Retención

Gestión de Webhooks

Tipos de Ítem Personalizados

Leer información de la empresa v1

Exportar datos de verificación a documento personalizado con variables de apoderados

Authorizations

Path Parameters

Body

Response