Crear solicitud

POST

https://apis.ecorpa.com

consulta

seguridad_social

curl -sS -X POST "https://apis.ecorpa.com/v2/consulta/seguridad_social" \
  -H "Authorization: Bearer ecorpa_key_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "AceptarTerminos": true,
    "Entidad": "adres",
    "SubirDocumentoAPlataforma": false,
    "Consultas": [
      {
        "TipoDocumentoIdentificacion": "CC",
        "NumeroIdentificacion": "1020304050"
      }
    ]
  }'

{
  "Success": true,
  "Message": "Su solicitud fue recibida y está en proceso.",
  "Data": {
    "Entidad": "adres",
    "Total": 2,
    "IdSolicitud": "bf009ced-f1dc-42a0-b173-60f20fe02bc3",
    "ConsultasAProcesar": [
      {
        "TipoDocumentoIdentificacion": "CC",
        "NumeroIdentificacion": "1020304050"
      }
    ],
    "ConsultasOmitidas": [
      {
        "TipoDocumentoIdentificacion": "XX",
        "NumeroIdentificacion": "111222333",
        "Motivo": "Tipo de identificación no válido para esta entidad."
      }
    ]
  }
}

Crea la solicitud y devuelve un IdSolicitud si hubo documentos aceptados. El resultado no viene aquí: se consulta con el GET. Scope: consultas_seguridad_social. Guía: Consultas seguridad social.

Probar desde aquí usa tu API Key y consume créditos por cada documento aceptado.

boolean

required

Debe ser true. Declara que tienes autorización del titular para consultar.

string

required

Fuente a consultar. Se normaliza a minúsculas. Hoy: adres. Detalle en ADRES.

boolean

default:"false"

Si es true, el archivo de respaldo también queda en la plataforma.

object[]

required

Documentos a consultar. Mínimo 1, máximo 100. Cada ítem aceptado consume 1 crédito.

Hide properties

string

required

Tipo permitido para esa entidad. En ADRES, ver tipos.

string

required

Solo dígitos 0-9.

boolean

true si la solicitud se recibió.

string

Texto de la operación.

object

Hide properties

string

Fuente enviada.

number

Aceptadas + omitidas.

string

UUID. Solo si hubo ítems aceptados.

object[]

Encolados. Consumen crédito.

object[]

No se procesan. Traen Motivo.

Si no hay ítems para procesar, la respuesta es 200 sin IdSolicitud y sin débito. Revisa ConsultasOmitidas.

curl -sS -X POST "https://apis.ecorpa.com/v2/consulta/seguridad_social" \
  -H "Authorization: Bearer ecorpa_key_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "AceptarTerminos": true,
    "Entidad": "adres",
    "SubirDocumentoAPlataforma": false,
    "Consultas": [
      {
        "TipoDocumentoIdentificacion": "CC",
        "NumeroIdentificacion": "1020304050"
      }
    ]
  }'

{
  "Success": true,
  "Message": "Su solicitud fue recibida y está en proceso.",
  "Data": {
    "Entidad": "adres",
    "Total": 2,
    "IdSolicitud": "bf009ced-f1dc-42a0-b173-60f20fe02bc3",
    "ConsultasAProcesar": [
      {
        "TipoDocumentoIdentificacion": "CC",
        "NumeroIdentificacion": "1020304050"
      }
    ],
    "ConsultasOmitidas": [
      {
        "TipoDocumentoIdentificacion": "XX",
        "NumeroIdentificacion": "111222333",
        "Motivo": "Tipo de identificación no válido para esta entidad."
      }
    ]
  }
}

⌘I

curl -sS -X POST "https://apis.ecorpa.com/v2/consulta/seguridad_social" \
  -H "Authorization: Bearer ecorpa_key_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "AceptarTerminos": true,
    "Entidad": "adres",
    "SubirDocumentoAPlataforma": false,
    "Consultas": [
      {
        "TipoDocumentoIdentificacion": "CC",
        "NumeroIdentificacion": "1020304050"
      }
    ]
  }'

{
  "Success": true,
  "Message": "Su solicitud fue recibida y está en proceso.",
  "Data": {
    "Entidad": "adres",
    "Total": 2,
    "IdSolicitud": "bf009ced-f1dc-42a0-b173-60f20fe02bc3",
    "ConsultasAProcesar": [
      {
        "TipoDocumentoIdentificacion": "CC",
        "NumeroIdentificacion": "1020304050"
      }
    ],
    "ConsultasOmitidas": [
      {
        "TipoDocumentoIdentificacion": "XX",
        "NumeroIdentificacion": "111222333",
        "Motivo": "Tipo de identificación no válido para esta entidad."
      }
    ]
  }
}

Consultas seguridad social

Consulta de antecedentes

Formularios de afiliación

Afiliaciones seguridad social

Crear solicitud