Skip to main content
Genera y actualiza formularios de afiliación enviando uno o varios trabajadores en una sola solicitud. El flujo es asíncrono: POST (crear o actualizar) → IdSolicitud → aviso a tu URL o GET hasta que cada ítem quede en procesado. Entre dos GET del mismo IdSolicitud espera al menos 10 segundos. El tipo de formulario lo eliges con Entidad. Cada uno tiene su página: códigos requeridos y ejemplo.

EPS

formularios_eps y CodigoEntidadEps.

CCF

formularios_ccf y CodigoEntidadCcf.

EPS y CCF

formularios_eps_ccf y ambos códigos.
Scope: formularios_afiliacion. Auth en Autenticación.

Endpoints

IdSolicitud es un UUID. Si el path no es un UUID válido, la ruta no existe.

Conceptos

POST — Crear

El ejemplo completo está en la página de cada entidad.

Body (raíz)

Al enviar AceptarTerminos: true, declaras:
Dando cumplimiento al Régimen General de Hábeas Data (Ley 1581 de 2012) y en calidad de Responsable, declaro que para efectuar la siguiente consulta de información personal, cuento con el consentimiento o autorización previa, expresa e informada del titular de los datos personales que serán consultados en tiempo real a través de esta plataforma. Así mismo, declaro que la consulta efectuada corresponde a una finalidad legitima, consistente en el cumplimiento de los procesos de debida diligencia, seguridad y/o normas sobre prevención y lucha contra el lavado de activos, el terrorismo y corrupción que la organización debe cumplir por mandato legal o como buena práctica empresarial.

Cada ítem en Registros

Tipos de documento, género, países, DANE y códigos EPS/CCF están en el instructivo Excel de cada módulo de formularios en la App. Se descarga ahí, con tu usuario.

Crear vs completar vs actualizar

  • Contrato nuevo → se crea.
  • Mismo contrato y falta la otra entidad (ej. ya hay EPS y envías CCF) → se completa el mismo formulario.
  • Mismo contrato y quieres cambiar datos o un código ya lleno → usa actualizar.
  • NumeroContrato no se puede cambiar en una actualización.

Respuesta (200)

Si no hay ítems para procesar: 200 sin IdSolicitud. Revisa RegistrosRechazados[].Motivos.

Errores del POST

POST — Actualizar

Mismo body que crear. Ubica el formulario por NumeroContrato y envía el registro completo.
  • Si hay cambios → se encola y consume 1 crédito.
  • Si no hay cambios o el contrato no existe → RegistrosRechazados.

GET — Consultar por IdSolicitud

Estados

Si una URL deja de funcionar, vuelve a llamar el GET.

Errores del GET

Flujo

1

POST crear

Envía Entidad y Registros. Guarda IdSolicitud y revisa RegistrosRechazados.
2

GET

Mientras algún ítem esté en procesando, vuelve a consultar.
3

PDF

Usa Formularios[].Url. Si hay que corregir, POST …/actualizar con el mismo NumeroContrato.

Checklist

  • API Key solo en backend
  • Scope formularios_afiliacion
  • NumeroContrato único; no se cambia en actualizar
  • Fechas en dd/mm/yyyy; celular 10 dígitos; DANE 5 dígitos
  • Maneja aceptados y RegistrosRechazados en la misma respuesta
  • Persiste IdSolicitud y consulta hasta procesado
  • Los créditos son los registros aceptados