Documentación

La funcionalidad permite a los usuarios cargar archivos desde su dispositivo a la plataforma, garantizando un manejo seguro y eficiente de los datos.

Request

📌 Recuerda que Avalsito dispone de varios entornos. Para más información, consulta 🔍 Enviroment.

Adjuntamos ducumentación a una operación concreta:

1- En Authorization comprobamos los parámetros.

2- Con una solicitud tipo ‘Post’ apuntaremos a la URL del entorno necesario.

3- Indicaremos en el Body la estructura de datos requerida en formato JSON.

4- Código cURL.

1. Authorization (Postman)

Key	Value	Requirement	DataType
Auth Type	Bearer Token	Required	parameter
Token	access_token	Required	String *

(*)access_token lo introduciremos en Postman sin comillas, a pesar de ser un String.

2. Enter URL (Postman)

Key	Value
URL	{baseURL}
Method	Post
Content-Type	raw

3. Body (Postman)

Variable	Description	Requirement	DataType
userName	Nombre de usuario	Required	String
password	Contraseña de usuario	Required	String
ContractingId	Identificador de operación	Required	String
DocumentType	Tipo de documento	Required	Int
FileType	Tipo de archivo	Required	Int
Name	Nombre del archivo	Required	String
File	Archivo codificado en Base64	Required	String

🔷userName: Identificación del usuario que realiza la solicitud (diferente al usuario vinculado a la compañía), proporcionada por el equipo de IT de Avalisto.

🔷password: Clave de acceso vinculada al usuario, también suministrada por el equipo de IT de Avalisto.

🔷ContractingId: Identificador de la operación, requerido para continuar con las acciones relacionadas, proporcionado en él Response de Scoring Request.

🔷DocumentType: (3.1) En este campo enviaremos el Value correspondiente al archivo adjunto.

🔷FileType: (3.2) Enviaremos el Value correspondiente a la extensión del archivo adjunto.

🔷Name: Nombre del archivo, se recomienda utilizar un nombre descriptivo que refleje su contenido. Ejemplos: Contrato de Arrendamiento, Nómina, etc.

🔷File: Campo que almacena un String en formato Base64, representando el contenido binario de un archivo.

3.1 DocumentType

DocumentType	Value
Contrato arrendamiento	11
Certificado Corriente Pago (DNS)	12
Justificante cesión de datos	13
Declaraciones de IVA	15
Nominas	16
Otros	17

3.2 FileType

Extension	Value
.jpg	1
.jpeg	2
.png	3
.pdf	4
.doc	5
.docx	6

4. Código cURL

curl --location 'https://api.avalisto.com/api/uplodaddocument' \
--header 'Authorization: Bearer D4pWQm1fpIAaAZvtiJAuoLUiciRugow-uqXzEPcvdnmHpurmnfNBRbaVr1IC9L7kxaRjpHePK9nCSJarwC-TMm5BXw2J3nl2Y5-m7n2PkqF5J3bGqRUx-mc4PJ6PQhcdlLqzIggQCvJaMG1hodnEIoWFk1KjAtzY0_z8BUH74oE1_DUUFJFPgnaeTVghNOsSRufzChs2GjcQYhtmwJr1no5v_l6J7GybDpLFQ1C7DwrHAfPcA0B6xyk2-fKdCNvX8j1HTFMR4szxyU2mSnbyyz1tvDRz6-izZ8q5VrA3qMFpnFL_YBnkaajGFgRAYQcf' \
--header 'Content-Type: application/json' \
--data '{
  "userName": "user",
  "password": "password",
  "ContractingId": 0000,
  "DocumentType": 17,
  "FileType": 4,
  "Name": "Vida Laboral",
  "File": "JVBERi0xLjcKJeLjz9MKNSAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDEwOTQ+PnN0cmVhbQp4nO1Xy27bOBTd6yu4bAGX4ZvUrCaJmyBAm6eLbrpxFTdwIcWNncz86/zG/EAvXxLpWJYMBJjNwAbEa/Gce84lpUDG/SAFAS"
}'

Response

📌 Una respuesta exitosa nos devolverá

---

✅ 200 OK.       Request successful. The server has responded as required

---

El Body de respuesta será en formato JSON con la siguiente estructura:

    "Message": "File uploaded successfuly",
    "Documents": [
        {
            "GuidId": "8c1e0200-877f-55d6-8507-3c56-9c7438a5dd6",
            "Name": "Vida Laboral",
            "DocumentTypeId": 17,
            "DocumentType": "Otros",
            "Date": "11/03/2025 16:26:02"
        },
        {
            "GuidId": "6a83ff26-3c56-4685-4a78-85fb-587f9a8b2c2c3",
            "Name": "Contrato arrendamiento",
            "DocumentTypeId": 11,
            "DocumentType": "Contrato",
            "Date": "11/03/2025 16:25:32"
        },
        {
            "GuidId": "6de57475-d700-4cbf-877f-8507-9c7438a5dd6",
            "Name": "Scoring aprobado en primera instancia",
            "DocumentTypeId": 24,
            "DocumentType": "ScoringApprovedTheFirstTime",
            "Date": "11/03/2025 15:17:02"
        }
    ],
    "Errors": null
}

🔷 “Message”: Resolución de la operación

🔷 “Documents”: Array con todos los documentos asociados a la solicitud.

🔷 “Errors”: Muestra errores sin interrumpir la operación.

 

❌ Error: Si la solicitud no prosperó, consulta el apartado ⚠️ Errores para más información.

  Avalisto emplea códigos de respuesta HTTP estándar para señalar el éxito o fracaso de una solicitud a la API.

El Body de respuesta será en formato JSON con la siguiente estructura:

{
    "Message": "Errors uploading file",
    "Documents": null,
    "Errors": [
        {
            "Code": "EI100",
            "Message": "Incorrect document type"
        }
    ]
}

El mensaje de error será descriptivo.