https://apis.ecorpa.com/v2.
Key de prueba
Puedes crear una key que empieza porecorpa_test_…. La URL es la misma que en producción.- No gasta créditos, no guarda datos y no envía el aviso.
- El
POSTresponde al instante con unIdSolicitudfijo y el estado ya enprocesado. - El
GETde ese id devuelve el ejemplo. Otro id responde que no encontró la solicitud.
Aviso cuando el lote termina
Puedes registrar una URL. Cuando el lote termina, ECORPA te envía el mismo resultado delGET.- Una sola URL, para los cuatro módulos:
PUT /v2/notificaciones. - El aviso llega en éxito y en error. El cuerpo trae
Modulo,IdSolicitudy el mismoDatadelGET. - El
GETsigue disponible. Espera al menos 10 segundos entre dos consultas del mismoIdSolicitud, y como máximo 30GETpor minuto. Si pasas el límite, la respuesta es429.
Volver a enviar
En el POST puedes enviarForzarReproceso: 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.
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-identidadrecibe 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, usaModuloextractor_documentos.
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.- Crear consulta de seguridad social
- Crear consulta de antecedentes
- Crear formulario
- Crear o reprocesar afiliación
- Enviar documento de identidad
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.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, …)
RastrearCertificado: true en el POST, el proceso puede seguir hasta certificado. Detalle en Afiliaciones seguridad social.Histórico del radicado
El GET de afiliaciones incluyeNovedades[]: 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.Cómo clasifica el POST
Un mismo lote puede devolver tres listas:Registros— se creaRegistrosReproceso— se retoma; puede traerCambiosy estados anterioresRegistrosRechazados— no se procesa; el motivo va enMotivos
IdSolicitud.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.Nuevo servicio
RutaPOST / 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.Opciones del POST
En crear y actualizar formulario puedes enviar:EnviarCorreo— manda el PDFFirmaTrabajador/FirmaCliente— incluye firmasIncluirArl— agrega ARL al formularioSubirDocumentoAPlataforma— también deja el archivo en la plataforma
false. Ver crear 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
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.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.Nuevo servicio
RutaPOST /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.procesando, completado, error
En el GET de antecedentes cada ítem puede quedar:procesando— aún no hay resultado; vuelve a consultarcompletado— listo para leerFuenteseInformePdferror— falló ese ítem
procesado.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.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.Nuevo servicio
RutaPOST / 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.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.Nuevo servicio
RutaPOST / 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.API Key y URL base
Las APIs de integración usanhttps://apis.ecorpa.com/v2 y el header:403). La key se crea en app.ecorpa.com → Configuración → API Keys.Guía: Autenticación.
