Configuración
Subir un archivo
Sube a VelaFi documentos de identidad para KYC/KYB o archivos de facturas. Admite hasta 5 archivos por solicitud en formato JPG, PNG, JPEG o PDF.
POST
/
v2
/
base
/
file
/
upload
Subir un archivo
curl --request POST \
--url https://api-test.velafi.com/v2/base/file/upload \
--header 'Content-Type: multipart/form-data' \
--header 'X-BH-TOKEN: <api-key>' \
--form 'businessType=<string>' \
--form files=@example-fileimport requests
url = "https://api-test.velafi.com/v2/base/file/upload"
files = { "files": ("example-file", open("example-file", "rb")) }
payload = { "businessType": "<string>" }
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('businessType', '<string>');
form.append('files', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {'X-BH-TOKEN': '<api-key>'}};
options.body = form;
fetch('https://api-test.velafi.com/v2/base/file/upload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/base/file/upload")
.header("X-BH-TOKEN", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"businessType\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"fileName": "<string>",
"fileType": "<string>",
"fileUrl": "<string>",
"tempFileUrl": "<string>"
}
]
}Usa el endpoint POST
/v2/base/file/upload para subir documentos a VelaFi. Este endpoint admite archivos de verificación de identidad KYC/KYB, así como documentos de facturas para cuentas de comercio. La solicitud debe enviarse como multipart/form-data. Puedes subir hasta cinco archivos en una sola solicitud; cada archivo debe pesar entre 10 KB y 3 MB y estar en uno de los formatos admitidos. La respuesta devuelve una URL firmada temporal para cada archivo subido, para que puedas verificar que la carga fue exitosa antes de hacer referencia al archivo en llamadas posteriores a la API.
Este endpoint requiere autorización. Incluye el encabezado
X-BH-TOKEN en cada solicitud. Las solicitudes sin un token válido serán rechazadas.Solicitud
POST /v2/base/file/upload
Encabezados
| Encabezado | Valor | Obligatorio |
|---|---|---|
X-BH-TOKEN | Tu token de GET /v2/token/generate | ✓ |
Content-Type | multipart/form-data | ✓ |
Parámetros del cuerpo
string
requerido
El tipo de documento de negocio que se sube. Actualmente su valor fijo es
FIAT_ACCOUNT.file
requerido
Uno o más archivos para subir. Máximo 5 archivos por solicitud. Cada archivo debe pesar entre 10 KB y 3 MB. Formatos admitidos:
jpg, jpeg, png, pdf.Campos de la respuesta
number
Código de estado de estilo HTTP.
200 indica éxito.string
Mensaje de estado legible, p. ej.
"SUCCESS".array
Arreglo de objetos de archivos subidos, uno por archivo.
Mostrar data[]
Mostrar data[]
string
Nombre original del archivo tal como se subió (p. ej.,
"id-front.jpg").string
Extensión del documento subido (p. ej.,
"jpg", "pdf").string
Ruta relativa de almacenamiento del archivo (p. ej.,
"100001/00000000-0000-0000-0000-000000000001.jpg"). Usa este valor cuando hagas referencia al archivo en llamadas posteriores a la API, por ejemplo en los campos de documentos (govIdFrontUrl, govIdBackUrl, certificateOfIncorporationDocumentUrl, taxIdentificationDocumentUrl) de una activación del canal Pix - Woovi.string
URL prefirmada temporal que puedes usar para verificar que el archivo se subió correctamente. Esta URL expira 30 minutos después de la carga y no debe almacenarse de forma permanente.
Ejemplo
curl --request POST \
--url 'https://api.velafi.com/v2/base/file/upload' \
--header 'X-BH-TOKEN: YOUR_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--form 'businessType=FIAT_ACCOUNT' \
--form 'files=@/path/to/id-front.jpg'
curl --request POST \
--url 'https://api.velafi.com/v2/base/file/upload' \
--header 'X-BH-TOKEN: YOUR_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--form 'businessType=FIAT_ACCOUNT' \
--form 'files=@/path/to/id-front.jpg' \
--form 'files=@/path/to/id-back.jpg'
Respuesta
{
"code": 200,
"msg": "SUCCESS",
"data": [
{
"fileName": "id-front.jpg",
"fileType": "jpg",
"fileUrl": "100001/00000000-0000-0000-0000-000000000001.jpg",
"tempFileUrl": "https://example-bucket.s3.amazonaws.com/00000000-0000-0000-0000-000000000001.jpg?X-Amz-Signature=..."
}
]
}
Guarda el campo
fileUrl de la respuesta: es la ruta relativa permanente a la que haces referencia en las solicitudes de envío de KYC/KYB. tempFileUrl es una URL firmada de corta duración, solo para verificación, y va a expirar.⌘I
Subir un archivo
curl --request POST \
--url https://api-test.velafi.com/v2/base/file/upload \
--header 'Content-Type: multipart/form-data' \
--header 'X-BH-TOKEN: <api-key>' \
--form 'businessType=<string>' \
--form files=@example-fileimport requests
url = "https://api-test.velafi.com/v2/base/file/upload"
files = { "files": ("example-file", open("example-file", "rb")) }
payload = { "businessType": "<string>" }
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('businessType', '<string>');
form.append('files', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {'X-BH-TOKEN': '<api-key>'}};
options.body = form;
fetch('https://api-test.velafi.com/v2/base/file/upload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/base/file/upload")
.header("X-BH-TOKEN", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"businessType\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"fileName": "<string>",
"fileType": "<string>",
"fileUrl": "<string>",
"tempFileUrl": "<string>"
}
]
}