Registrations
Create a registration

Create a registration

⚠️

Add test=1 to run tests without real effects. In production, omit this parameter.

Parameters

  • test (number (1)) : For testing, add the test=1 parameter. It must be omitted in production.
  • regimen (integer) : Scheme, 4 digits. Possible values:
  • ccc (integer) : Contribution account code, 11 digits.
  • nss (integer) : Social Security number, 12 digits.
  • identificacion (integer) : Identification number. Possible values:
    • 1: DNI
    • 2: Passport
    • 6: NIE
  • dni (string) : National identity document.
  • fecha_real (date) : Registration date, format YYYY-MM-DD.
  • grupo_cotizacion (integer) : Contribution group, maximum 2 digits. Possible values:
  • tipo_contrato (integer) : Contract type, 3 digits. Possible values:
  • cno (integer) : National Classification of Occupations, maximum 4 digits. Possible values:
  • category_professional (integer) : Professional category, valid only for the Artists Scheme (0112), 7 digits, mandatory. Possible values:
  • coeficiente (integer) : Part-time coefficient, for part-time working hours, maximum 3 digits. Optional.
  • rlce (integer) : Special Employment Relationship, maximum 4 digits, optional. Possible values:
  • worker_collective (integer) : Worker collective; mandatory for contract types (402, 502, 407, 507), 3 digits, optional. Possible values:
  • ocupacion (string) : Worker's occupation, optional. Possible values:
  • convenio (integer) : Collective agreement, 14 digits, optional. Possible values:
  • modalidad_ctz (integer) : Contribution method, optional.
    • Valid for the Agricultural Scheme (0163), possible values:
      • 1: Monthly contribution
      • 2: Actual days worked
    • Also valid for other schemes when tipo_contrato is 421, 521 or grupo_cotizacion is 08, 09, 10 or 11, possible values:
      • 1: Monthly contribution
      • If not sent, it is not monthly.
  • fic (date) : Specific contract start date. For moving between contribution accounts within the same company or group of companies, format YYYY-MM-DD. Optional.
  • sust_cause (integer) : Replacement reason, 2 digits, optional. Possible values:
  • sust_nss (integer) : Social Security number, 12 digits, mandatory if a replacement reason is given. Optional.
  • duplicate (integer) : Get the PDF as base64 in JSON format in the response; possible values are 1 or null. Optional.
  • obtener_idc (integer) : Get the IDC PDF as base64 in JSON format in the response; possible values are 1 or null. Optional. The request will take longer to respond.
  • exc_ctz (integer) : Employment relationship type, 3 digits, optional. Possible values:
  • cond_desempleado (string): Unemployment status, optional. Possible values:
  • beneficios (string): Benefits, optional. Required when cond_desempleado = 1. Possible values:
  • fom_empl_agrario (integer): For the Agricultural Scheme, optional. Possible values:
    • 1: Agricultural employment promotion
    • 2: With excess contribution < 30D.
  • sexo (string) : Sex, optional. Possible values:
    • M: Male
    • F: Female
  • fnacimiento (date) : Date of birth, optional. Format YYYY-MM-DD.
  • exc_desempleo (integer) : Unemployment exclusion, optional. Possible values:
    • 9: Circular migration, permanent seasonal workers
POST /alta
{
  "test": 1,
  "regimen": "0111",
  "ccc": 12345678901,
  "nss": "123456789012",
  "identificacion": 1,
  "dni": "12345678A",
  "fecha_real": "2023-01-01",
  "grupo_cotizacion": 12,
  "tipo_contrato": 402,
  "cno": 1234,
  "category_professional": 1234567,
  "coeficiente": "500",
  "rlce": 1234,
  "worker_collective": 123,
  "ocupacion": "a",
  "convenio": 12345678901234,
  "modalidad_ctz": 2,
  "fic": "2023-02-01",
  "duplicate": 1
}

Response

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "file": {
      "contentType": "application/pdf",
      "name": "document.pdf",
      "content": "base64"
    },
    "idc": {
      // Si se envia obtener_idc = 1
      "contentType": "application/pdf",
      "name": "document.pdf",
      "content": "base64"
    }
  }
}