Aportantes Sandbox

El API aportantes utiliza las siguientes cabeceras para su uso:

• app_id: Es un código generado por Nubloq para la identificación de quién esté haciendo uso de la API.

Solicitud

Una vez se entregan las credenciales por parte de Nubloq, se pueden ejecutar las peticiones mediante llamados POST. Para ello, se usan los siguientes parámetros:

• URL de la petición: 'https://apim-prod-data.nubloq.app/v2/sandbox/aportantes'

• Tipo de método: 'POST'

POST https://apim-prod-data.nubloq.app/v2/sandbox/aportantes

Headers

Name	Type	Description
app_id*	String	{app_id}
Authorization*	String	{token_type} {access_token}

Request Body

Name	Type	Description
tipo_documento*	String	CC
num_documento*	String	6361846

200: OK Esta respuesta se da cuando el usuario es encontrado en nuestros registros de manera exitosa.

{
    "status": true,
    "message": null,
    "requestID": "196ec...",
    "tipoDocumentoAportante": "CC",
    "numeroDocumentoAportante": "6361846",
    "periodos": [
        {
            "periodoCotizacion": "202201",
            "razonSocial": "CONRADO TASCON",
            "tipoDocumentoRepresentanteLegal": "CC",
            "numeroDocumentoRepresentanteLegal": "6361746",
            "primerNombreRepresentanteLegal": "MIGUEL",
            "segundoNombreRepresentanteLegal": "ANTONIO",
            "primerApellidoRepresentanteLegal": "FLOR",
            "segundoApellidoRepresentanteLegal": "LONDONO",
            "codigoActividadEconomica": "7490",
            "descActividadEconomica": "Actividades de la práctica médica sin internación",
            "codigoClaseAportante": "A",
            "descClaseAportante": "Aportante con 200 o mas cotizantes",
            "codigoTipoAportante": "1",
            "descTipoAportante": "Empleador",
            "codigoTipoPersona": "N",
            "descTipoPersona": "NATURAL",
            "numeroDeEmpleados": "2",
            "valorNomina": "1817052",
            "valorSinMoraParafiscales": "32000",
            "valorConMoraParafiscales": "0",
            "valorParafiscales": "32000"
        },
        {
            "periodoCotizacion": "202201",
            "razonSocial": "CONRADO TASCON",
            "tipoDocumentoRepresentanteLegal": "CC",
            "numeroDocumentoRepresentanteLegal": "6361746",
            "primerNombreRepresentanteLegal": "MIGUEL",
            "segundoNombreRepresentanteLegal": "ANTONIO",
            "primerApellidoRepresentanteLegal": "FLOR",
            "segundoApellidoRepresentanteLegal": "LONDONO",
            "codigoActividadEconomica": "7490",
            "descActividadEconomica": "Actividades de la práctica médica sin internación",
            "codigoClaseAportante": "A",
            "descClaseAportante": "Aportante con 200 o mas cotizantes",
            "codigoTipoAportante": "1",
            "descTipoAportante": "Empleador",
            "codigoTipoPersona": "N",
            "descTipoPersona": "NATURAL",
            "numeroDeEmpleados": "2",
            "valorNomina": "1817052",
            "valorSinMoraParafiscales": "3700",
            "valorConMoraParafiscales": "0",
            "valorParafiscales": "3700"
        }
    ]
}

400: Bad Request Esta respuesta se da cuando el cuerpo y los encabezados de la petición están mal formados.

{
    "status": false,
    "requestID": null,
    "message": "Bad request"
}

401: Unauthorized Esta respuesta se da cuando falta el encabezado “Authorization” o tiene un valor no válido.

{
    "statusCode": 401,
    "message": "Unauthorized. Access token is missing or invalid."
}

403: Forbidden Esta respuesta se da cuando el usuario no está autorizado para consumir el servicio.

{
    "status": false,
    "requestID": “9138c6a3-...”,
    "message": "Acceso no autorizado!."
}

404: Not Found Esta respuesta se da cuando el usuario no existe en nuestros registros.

{
    "status": false,
    "requestID": "9138c6a3-...",
    "message": "Usuario no encontrado."
}

500: Internal Server Error Esta respuesta se da cuando ocurre una excepción no controlada.

{
    "status": false,
    "requestID": "9138c6a3-...",
    "message": "Internal server error."
}

Nota: Se debe informar a Nubloq el listado de las direcciones IP que van a consumir el servicio, para así proceder a otorgar los permisos necesarios.

Para el campo “tipo_documento” los valores válidos son los siguientes (se debe ingresar el campo nomenclatura):

Nomenclatura	Tipo De Documento
CC	Cédula de Ciudadanía
CD	Carné Diplomático
CE	Cédula Extranjería
NI	NIT
PA	Pasaporte
PE	Permiso Especial
SC	Salvoconducto de permanencia
TI	Tarjeta de identidad
PT	Permiso por protección temporal en activos y pensionados

curl --location 'https://https://apim-prod-data.nubloq.app/v2/sandbox/aportantes' \
--header 'app_id: {app_id}' \
--header 'Authorization: {token_type} {access_token}' \
--header 'Content-Type: application/json' \
--data '{     
    "tipo_documento": "CC",     
    "num_documento": "6361846"
} '