Skip to main content
Lo que cambia en las APIs: servicios nuevos, campos y rutas. La base sigue siendo https://apis.ecorpa.com/v2.
Auth
API key de prueba

Key de prueba

Puedes crear una key que empieza por ecorpa_test_…. La URL es la misma que en producción.
  • No gasta créditos, no guarda datos y no envía el aviso.
  • El POST responde al instante con un IdSolicitud fijo y el estado ya en procesado.
  • El GET de ese id devuelve el ejemplo. Otro id responde que no encontró la solicitud.
Los id fijos están en Autenticación.
ConsultasAntecedentesFormulariosAfiliaciones
Aviso al terminar

Aviso cuando el lote termina

Puedes registrar una URL. Cuando el lote termina, ECORPA te envía el mismo resultado del GET.
  • Una sola URL, para los cuatro módulos: PUT /v2/notificaciones.
  • El aviso llega en éxito y en error. El cuerpo trae Modulo, IdSolicitud y el mismo Data del GET.
  • El GET sigue disponible. Espera al menos 10 segundos entre dos consultas del mismo IdSolicitud, y como máximo 30 GET por minuto. Si pasas el límite, la respuesta es 429.
Guía: Avisos. Referencia: registrar URL.
ConsultasAfiliaciones
ForzarReproceso

Volver a enviar

En el POST puedes enviar ForzarReproceso: true (también Forzar o Enforce). Por defecto es false.
  • Consultas de seguridad social: consulta de nuevo aunque ya exista un resultado reciente. No aplica si hay una consulta en curso.
  • Afiliaciones: reencola aunque el registro ya esté radicado, certificado o procesado. No aplica si hay un proceso en curso.
Referencia: crear consulta y crear o reprocesar afiliación.
Extractor
Documento de identidad

Extractor de documento de identidad

Extrae la información del documento de identidad y revisa la calidad de la lectura.
  • POST /v2/extractor-documentos/documento-identidad recibe hasta 5 PDF en base64, de hasta 2 MB cada uno.
  • GET /v2/extractor-documentos/documento-identidad/{IdSolicitud} devuelve los campos del documento, el código DANE cuando se encuentra, el formato y las caras.
  • Scope: extractor_documentos. El aviso, cuando la extracción termina, usa Modulo extractor_documentos.
Guía: Documento de identidad.
Documentación
Referencia de la API

Referencia de la API

Cada endpoint tiene su propia página: método, body, respuesta y un ejemplo a la derecha. Puedes probar la llamada con tu API Key.La guía de cada servicio (flujo, estados, entidades) sigue en Documentación.
FormulariosAfiliaciones
Instructivos en la App

Instructivos de campos y códigos

Tipos de documento, género, países, DANE y códigos de entidad no se publican en estas docs. Se descargan en la App, en el módulo de formularios o de afiliaciones, con tu usuario.Así el catálogo que usas al integrar es el mismo que ves en plataforma.
Documentación
docs.ecorpa.com

Documentación pública

La documentación de integración queda en docs.ecorpa.com: autenticación, servicios y ejemplos.Para interpretar resultados de ADRES y de antecedentes, los artículos están en ecorpa.com.
Afiliaciones
EstadoEntidad y certificado

Estado ante la entidad

En el GET de afiliaciones cada registro trae dos capas:
  • Estado — el lote (procesando, procesado, error)
  • EstadoEntidad — lo que ocurrió ante la entidad (radicado, certificado, devuelto, …)
Si envías RastrearCertificado: true en el POST, el proceso puede seguir hasta certificado. Detalle en Afiliaciones seguridad social.
Afiliaciones
Novedades y evidencias

Histórico del radicado

El GET de afiliaciones incluye Novedades[]: cada paso con Orden, Fase, Mensaje y Fecha. Si ese paso tiene archivo, viene Evidencia.Si una URL deja de funcionar, vuelve a llamar el GET. Ver consultar solicitud.
Afiliaciones
Afiliación AFP

AFP

Ya puedes radicar ante AFP con Entidad: "afiliaciones_seguridad_social_afp" y CodigoEntidad de la administradora en cada registro.Misma ruta POST / GET /v2/afiliaciones/seguridad_social. Guía: AFP.
Afiliaciones
Afiliación ARL

ARL

Radicación ante ARL con Entidad: "afiliaciones_seguridad_social_arl". El CodigoEntidad va por registro.Guía: ARL.
Afiliaciones
Nuevo, reproceso y rechazo

Cómo clasifica el POST

Un mismo lote puede devolver tres listas:
  • Registros — se crea
  • RegistrosReproceso — se retoma; puede traer Cambios y estados anteriores
  • RegistrosRechazados — no se procesa; el motivo va en Motivos
HTTP 200 en los tres casos. Solo los nuevos y los reprocesos aceptados consumen crédito. Si no hay nada que procesar, no viene IdSolicitud.
Afiliaciones
Canal plataforma o asesor

Canal de radicación

Cada afiliación se radica por plataforma o asesor. Puedes fijarlo en la raíz del POST o por registro.Si un ítem trae Canal, ese gana. Si no, se usa el de la raíz. Cada entidad debe tener en ECORPA las credenciales del canal que vas a usar.Detalle y ejemplo en Canal.
Afiliaciones
Afiliación CCF

Caja de compensación

Radica ante CCF con Entidad: "afiliaciones_seguridad_social_ccf" y CodigoEntidad de la caja en cada registro.Guía: CCF.
Afiliaciones
Afiliación EPS

EPS

Primera entidad de radicación directa: Entidad: "afiliaciones_seguridad_social_eps". Esto no genera un PDF: envía la novedad a la entidad.Para solo el formulario, sigue usando Formularios de afiliación. Guía: EPS.
Afiliaciones
Afiliaciones seguridad social

Nuevo servicio

Ruta POST / GET /v2/afiliaciones/seguridad_social. Scope: afiliaciones_seguridad_social.Mismo flujo asíncrono: creas el lote, guardas IdSolicitud, consultas hasta que cada registro termine. CodigoEntidad y NitEmpresa van por trabajador.Referencia: crear o reprocesar.
Formularios
Firmas y envío de PDF

Opciones del POST

En crear y actualizar formulario puedes enviar:
  • EnviarCorreo — manda el PDF
  • FirmaTrabajador / FirmaCliente — incluye firmas
  • IncluirArl — agrega ARL al formulario
  • SubirDocumentoAPlataforma — también deja el archivo en la plataforma
Todos son opcionales y por defecto false. Ver crear formulario.
Formularios
Actualizar formulario

POST actualizar

Nueva ruta: POST /v2/formularios/afiliacion/actualizar.Ubica el formulario por NumeroContrato y pide el registro completo. Ese número no se cambia.
  • Si hay cambios → se encola y consume 1 crédito
  • Si no hay cambios o el contrato no existe → RegistrosRechazados
Referencia: actualizar formulario.
Formularios
EPS y CCF en el mismo contrato

Completar el formulario

Con Entidad: "formularios_eps_ccf" (o enviando la entidad que faltaba al mismo NumeroContrato) se completa el formulario que ya existía: no se crea otro.Si el contrato ya tiene EPS y CCF y quieres cambiar datos, usa actualizar. Guía: EPS y CCF.
Formularios
Formulario CCF

Caja de compensación

Genera el PDF de CCF con Entidad: "formularios_ccf" y CodigoEntidadCcf en cada registro.Guía: CCF.
Formularios
NumeroContrato

Clave del formulario

NumeroContrato es único. Identifica el formulario en crear, completar y actualizar.En el GET vuelve en cada registro. No lo reutilices entre trabajadores distintos.
Formularios
GET de formularios

PDF en la consulta

GET /v2/formularios/afiliacion/{IdSolicitud} ahora trae Formularios[] cuando el registro está procesado: Tipo (EPS / CCF), Version, Url y si se envió correo.Mientras esté procesando, vuelve a consultar. Si una URL deja de funcionar, llama otra vez el GET. Referencia: consultar solicitud.
Formularios
Formulario EPS

Primera entidad de formularios

Entidad: "formularios_eps" y CodigoEntidadEps por registro. El POST crea el lote; el PDF llega en el GET.Guía: EPS.
Formularios
Formularios de afiliación

Nuevo servicio

Ruta POST /v2/formularios/afiliacion y GET /v2/formularios/afiliacion/{IdSolicitud}. Scope: formularios_afiliacion.Envías uno o varios trabajadores. Cada registro aceptado consume 1 crédito; los rechazados van en RegistrosRechazados con Motivos.Guía: Formularios de afiliación.
Antecedentes
Estados de antecedentes

procesando, completado, error

En el GET de antecedentes cada ítem puede quedar:
  • procesando — aún no hay resultado; vuelve a consultar
  • completado — listo para leer Fuentes e InformePdf
  • error — falló ese ítem
Distinto de consultas de seguridad social, donde el estado final es procesado.
Antecedentes
Informe y evidencias

PDF consolidado

Cuando el ítem está completado pueden venir InformePdf, PorcentajeConfianza, TieneHallazgos y Fuentes[]. Cada fuente puede traer sus propias evidencias.Cómo leer el resultado: artículo en ecorpa.com. Contrato: persona natural.
Antecedentes
Persona natural

Tipo de consulta

El lote de antecedentes es de persona natural: tipo y número de documento. FechaExpedicionDocumentoIdentidad es opcional (dd/mm/yyyy).Si no la envías, la solicitud se crea, pero las fuentes que la requieren no se consultan. Más información.
Antecedentes
Consulta de antecedentes

Nuevo servicio

Ruta POST / GET /v2/consulta/antecedentes. Scope: consulta_antecedentes.Mismo patrón: lote de hasta 100, ConsultasAProcesar y ConsultasOmitidas, IdSolicitud solo si hubo aceptadas. Las fuentes se consultan juntas en esa solicitud.Guía: Consulta de antecedentes.
Consultas
Resultado ADRES

Afiliado y no afiliado

Cuando el ítem está procesado, Resultado.Tipo es afiliado o no_afiliado. Eso no es un error HTTP: el ítem igual quedó procesado.
Consultas
Entidad ADRES

Primera fuente

Entidad: "adres" en el POST. El tipo de documento no válido se omite (ConsultasOmitidas), no tumba el lote.Tipos y forma del Resultado: ADRES.
Consultas
Consultas seguridad social

Nuevo servicio

Ruta POST / GET /v2/consulta/seguridad_social. Scope: consultas_seguridad_social.Envías hasta 100 documentos. Cada aceptado consume 1 crédito. Guardas Data.IdSolicitud y consultas hasta procesado.Guía: Consultas seguridad social. Referencia: crear solicitud.
Auth
Autenticación y APIs v2

API Key y URL base

Las APIs de integración usan https://apis.ecorpa.com/v2 y el header:
Cada servicio pide su scope. Sin él, la llamada no pasa (403). La key se crea en app.ecorpa.com → Configuración → API Keys.Guía: Autenticación.