Enviar una solicitud de inscripción para una persona (desde el servidor)

POST

/v1/enroll

const url = 'https://api.vimine.network/v1/enroll';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"hello@example.com","first_name":"example","last_name":"example","codicefiscale":"example","codicefiscale_confirmed":true,"guardian":{"first_name":"example","last_name":"example","relation":"example","codicefiscale":"example","email":"hello@example.com","phone":"example"},"address":{"kind":"residence","line":"example","postal_code":"example","city":"example","province":"example","country":"IT"},"phone":"example","dob":"2026-04-15","gender":"M","birthplace":"example","birth_country":"example","membership_type":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","locale":"example","accept_statuto":{"version":1,"sha256":"example"},"privacy_notice":{"version":1,"sha256":"example","locale":"example"},"accept_terms":{"version":"example","sha256":"example"},"acknowledge_privacy":{"version":"example","sha256":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.vimine.network/v1/enroll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "first_name": "example", "last_name": "example", "codicefiscale": "example", "codicefiscale_confirmed": true, "guardian": { "first_name": "example", "last_name": "example", "relation": "example", "codicefiscale": "example", "email": "hello@example.com", "phone": "example" }, "address": { "kind": "residence", "line": "example", "postal_code": "example", "city": "example", "province": "example", "country": "IT" }, "phone": "example", "dob": "2026-04-15", "gender": "M", "birthplace": "example", "birth_country": "example", "membership_type": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "locale": "example", "accept_statuto": { "version": 1, "sha256": "example" }, "privacy_notice": { "version": 1, "sha256": "example", "locale": "example" }, "accept_terms": { "version": "example", "sha256": "example" }, "acknowledge_privacy": { "version": "example", "sha256": "example" } }'

Crea la identidad, cuando la dirección es nueva, y la solicitud de inscripción (emitida ACTIVE de inmediato para un tipo gratuito que no requiere aprobación; si no, PENDING hasta que la asociación registra la cuota y/o la aprueba). Una dirección que ya tiene una cuenta de Vimine nunca se vincula en silencio: su titular recibe un enlace de confirmación y la solicitud se crea cuando lo usa. Responde siempre 202. accept_statuto debe nombrar la versión del estatuto en vigor (y el sha256 cuando se publica). Solo tokens de cliente (enroll:write); acepta Idempotency-Key.

Autorizaciones

BearerToken
enroll:write
ClientBasic

Cuerpo de la petición^obligatorio

application/json

object

email

obligatorio

string formato: email

first_name

obligatorio

string

<= 50 caracteres

last_name

obligatorio

string

<= 50 caracteres

codicefiscale

Opcional. Una persona se identifica con un código fiscal O con dob + birthplace + birth_country — nunca sin ninguno de los dos (422 required en cada dato que falte). Cuando está presente, se valida y se coteja con el nombre y los apellidos, la fecha y el lugar (el país, para las personas nacidas en el extranjero)

string

nullable <= 16 caracteres

codicefiscale_confirmed

La persona confirma un código que no coincide con sus datos (422 codicefiscale_mismatch con confirmable: true)

boolean

guardian

Quien ejerce la responsabilidad parental sobre un menor (menos de 18 años según dob). OBLIGATORIO para un menor donde la asociación ha declarado que recoge este bloque (aps.collects_guardian_data): si no, 422 required en guardian; solo se guarda donde la asociación lo ha declarado

object

first_name

obligatorio

string

<= 50 caracteres

last_name

obligatorio

string

<= 50 caracteres

relation

obligatorio

Progenitor, tutor… tal como lo registra la asociación

string

<= 20 caracteres

codicefiscale

Opcional; se rechaza si está mal formado

string

nullable <= 16 caracteres

email

string formato: email

nullable

phone

string

nullable <= 20 caracteres

address

Residencia o, cuando difiere, domicilio. Se pide a todos los socios o a ninguno: el perfil público dice lo que ha declarado la asociación (member_address: none — se ignora, no se guarda · optional · required — 422 required en address sin ella)

object

kind

string

por defecto: residence

Valores permitidos: residence domicile

line

obligatorio

Calle y número

string

<= 150 caracteres

postal_code

string

nullable <= 12 caracteres

city

obligatorio

string

<= 150 caracteres

province

Solo direcciones italianas (dos letras); se descarta para las del extranjero

string

nullable <= 2 caracteres

country

ISO 3166-1 alpha-2

string

por defecto: IT >= 2 caracteres <= 2 caracteres

phone

string

nullable <= 20 caracteres

dob

string formato: date

nullable

gender

Solo demográfico: no se coteja

string

nullable

Valores permitidos: M F

birthplace

Comune (nacidos en Italia) o ciudad, texto libre (nacidos en el extranjero)

string

nullable <= 150 caracteres

birth_country

ISO 3166-1 alpha-2

string

nullable >= 2 caracteres <= 2 caracteres

membership_type

Uno de los tipos de carné de la asociación (omítelo cuando tiene exactamente uno)

string formato: uuid

locale

El idioma de la página que ha rellenado la persona (un idioma de la plataforma — it, en, …; cualquier otra etiqueta se reduce a uno de los de la plataforma: en-GB → en, zh-TW → zh-Hant). Decide el idioma de los correos que siguen y se convierte en la preferencia de una cuenta NUEVA; una cuenta existente conserva la suya. Los valores no admitidos se ignoran

string

nullable

accept_statuto

obligatorio

El estatuto en vigor que la persona ha aceptado en tu sitio (de GET /v1/aps/{slug})

object

version

obligatorio

integer

sha256

string

privacy_notice

La política de privacidad de la asociación que la persona ha leído en tu sitio (GET /v1/aps/{slug} → privacy_notice). OBLIGATORIO cuando la asociación publica una; 422 privacy_notice_outdated cuando no es la versión en vigor

object

version

obligatorio

La versión en vigor de la política que se ha mostrado (GET /v1/aps/{slug} → privacy_notice)

integer

sha256

string

locale

El idioma de la política que mostraste (privacy_notice.locale de la respuesta en la que la leíste). Cada idioma es un documento propio, con su propia versión: indícalo cuando leas el perfil con ?locale=. Por defecto: el locale de la petición y, después, el idioma de la asociación

string

accept_terms

Las condiciones de la cuenta (platform_terms) que la persona ha aceptado en tu sitio — opcional, debe nombrar la versión en vigor

object

version

obligatorio

La etiqueta de la versión en vigor que se ha mostrado (GET /v1/legal/{kind})

string

sha256

El hash de su plantilla, cuando se publica

string

acknowledge_privacy

La política de privacidad de la plataforma (platform_privacy) que la persona ha leído — opcional, misma regla

object

version

obligatorio

La etiqueta de la versión en vigor que se ha mostrado (GET /v1/legal/{kind})

string

sha256

El hash de su plantilla, cuando se publica

string

Respuestas

202

Aceptada

application/json

object

status

obligatorio

string

Valores permitidos: accepted

Ejemplo

{
  "status": "accepted"
}

400

Petición no válida

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

401

Credenciales ausentes o no válidas

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

403

La asociación no acepta solicitudes de inscripción (api_disabled)

404

No encontrado

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Validación fallida, tipo de carné desconocido o accept_statuto no nombra el estatuto en vigor

429

Límite de frecuencia superado

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Error interno

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

Enviar una solicitud de inscripción para una persona (desde el servidor)

Autorizaciones

Cuerpo de la peticiónobligatorio

Respuestas

202

Ejemplo

400

Ejemplogenerado

401

Ejemplogenerado

403

404

Ejemplogenerado

422

429

Ejemplogenerado

500

Ejemplogenerado

Cuerpo de la petición^obligatorio

Ejemplo^generado

Ejemplo^generado

Ejemplo^generado

Ejemplo^generado

Ejemplo^generado