Send an account invitation

Invite a person by email to join the account with a role (admin or member) and a required grants list (may be empty). - Only a member carries grants; an admin invite needs a scope covering every tax ID.

Returns 201. - secret and accept_url appear once, only with send_email: false. - Missing grants returns 400 parameter_missing.
Requires the invitations:write scope, which * does not cover: the API key must list it explicitly.

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

account*string

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

Formatuuid

Headers

Idempotency-Key*string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Length1 <= length <= 255

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Email address the invitation is sent to.

Formatemail

Lengthlength <= 255

role*string

Account role the person would join with: admin or member.

Value in"admin" | "member"

grants*array<>

Initial per-tax-ID grants of the invited person. Required, it can be empty; only a member carries grants.

send_email?boolean

Send the invitation email (true, default) or only return the acceptance link (false).

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/accounts/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/invitations", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-account-invitations-create"} },  body: JSON.stringify({  "email": "facturacion@acme.example",  "role": "admin",  "grants": [    {      "company_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",      "level": "view"    }  ]}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "id": "01933a51-3d52-7b9c-8d1e-2f3a4b5c6d01",
    "object": "account_invitation",
    "email": "laura@acme.example",
    "role": "member",
    "grants": [
      {
        "object": "account_member_grant",
        "company_id": "0193f1a0-5c2e-7b41-8d06-9a1e2f3c4d5e",
        "level": "view"
      }
    ],
    "send_email": false,
    "external_advisor": false,
    "status": "pending",
    "expires_at": "2026-10-03T09:15:00Z",
    "created_at": "2026-09-26T09:15:00Z",
    "sent_at": "2026-09-26T09:15:00Z",
    "invited_by": {
      "id": "01933a50-2c41-7a8b-9c0d-1e2f3a4b5c02",
      "name": "Jordi Puig"
    },
    "secret": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "accept_url": "https://app.factuarea.com/invitation/accept?token=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  }
}

Retired X-Active-Profile header sent

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Malformed Factuarea-Version header

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Unsupported Factuarea-Version

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

Missing API key

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

Invalid API key format

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "La API key no tiene el formato esperado (debe empezar por fact_live_ o fact_test_).",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_api_key",
    "request_id": "req_01HKQS5N9JTQM7HVTQP3FBN5XB"
  }
}

Revoked API key

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_revoked",
    "message": "Esta API key ha sido revocada y ya no es válida.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#api_key_revoked",
    "request_id": "req_01HKQS5NA8K7E2V9YDZWMT6RJC"
  }
}

Expired API key

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_expired",
    "message": "Esta API key ha caducado.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#api_key_expired",
    "request_id": "req_01HKQS5NAPIKEYEXPIRED00008"
  }
}

Request IP outside the API key allowlist

{
  "error": {
    "type": "authentication_error",
    "code": "ip_not_allowed",
    "message": "La IP 203.0.113.10 no está autorizada para esta API key.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#ip_not_allowed",
    "request_id": "req_01HKQS5NIPNOTALLOWED000009"
  }
}

API key lacks required scope

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

Plan upgrade required

{
  "error": {
    "type": "authorization_error",
    "code": "feature_not_available_in_plan",
    "message": "Esta funcionalidad requiere el plan empresario o superior. Actualiza tu suscripción para acceder.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#feature_not_available_in_plan",
    "request_id": "req_01HKQS5NCK4V9N2L7Y8X3WPMRE"
  }
}

Plan without public API access

{
  "error": {
    "type": "authorization_error",
    "code": "addon_not_active",
    "message": "Tu plan actual no incluye acceso a la API pública. Contrata o renueva un plan de Factuarea para usar la API.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#addon_not_active",
    "request_id": "req_01HKQS5NDP5W0Q3M8Z9A4BVSNF"
  }
}

Module not available with a test key

{
  "error": {
    "type": "authorization_error",
    "code": "module_not_available_in_sandbox",
    "message": "El módulo \"verifactu\" no está disponible en modo de pruebas. Usa una clave fact_live_ para operar sobre este recurso.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#module_not_available_in_sandbox",
    "request_id": "req_01HKQS5NMODULESANDBOX00010"
  }
}

Account provider privilege not granted

{
  "error": {
    "type": "authorization_error",
    "code": "privileged_scope_required",
    "message": "Esta operación exige el privilegio de proveedor de cuentas (accounts:*) y la persona que emitió la clave debe ser propietaria o administradora de la cuenta",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#privileged_scope_required",
    "request_id": "req_01HKQS5NPRIVILEGEDSCOPE001"
  }
}

Operation of the owning account on a tax ID reached through a relation

{
  "error": {
    "type": "authorization_error",
    "code": "forbidden_action",
    "message": "Esta operación solo la puede hacer la cuenta dueña del NIF: con un acceso por relación entre cuentas no está disponible.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#forbidden_action",
    "request_id": "req_01HKQS5NRELATIONNIFOWNER01"
  }
}

Section withdrawn from the person who issued the key

{
  "error": {
    "type": "authorization_error",
    "code": "emitter_capability_restricted",
    "message": "El acceso a la sección «invoices» está restringido para la persona emisora de esta credencial en esta empresa. Pide al administrador de la empresa que lo habilite.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#emitter_capability_restricted",
    "request_id": "req_01J8Y3M2Q40000000000000012"
  }
}

Test key on a write that changes a live account

{
  "error": {
    "type": "authorization_error",
    "code": "live_credential_required",
    "message": "Esta operación modifica la cuenta y exige una clave de producción (fact_live_)",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#live_credential_required",
    "request_id": "req_01J8Y3M2Q40000000000000010"
  }
}

Write with read-only access to the company

{
  "error": {
    "type": "authorization_error",
    "code": "company_read_only",
    "message": "Tu acceso a esta empresa es de solo lectura.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_read_only",
    "request_id": "req_01J8Y3M2Q40000000000000011"
  }
}

Resource not found

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "El recurso solicitado no existe o pertenece a otra empresa.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_01HKQS5NEQ6X1R4N9B0C5DWTPG"
  }
}

Account not found or not the account of the API key

{
  "error": {
    "type": "not_found_error",
    "code": "account_not_found",
    "message": "La cuenta indicada no existe o no es la de tu credencial.",
    "param": "account",
    "doc_url": "https://docs.factuarea.com/guides/errors#account_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000006"
  }
}

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "Hay otra operación reservando identificadores sobre 'invitations' en este momento y no ha podido completarse la reserva. Vuelve a intentarlo dentro de unos segundos; la operación es reintentable y no ha dejado nada a medias.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000IDR1"
  }
}

Parameter failed validation

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

Invalid Idempotency-Key format

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_01HKQS5NIDEMPKEYFORMAT0007"
  }
}

Plan limit reached (authorization)

{
  "error": {
    "type": "authorization_error",
    "code": "max_api_keys_exceeded",
    "message": "Has alcanzado el número máximo de API keys permitido por tu plan. Revoca alguna existente o actualiza tu suscripción.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#max_api_keys_exceeded",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSJ"
  }
}

Invoice language outside the allowed catalog

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El idioma no es válido. Valores permitidos: es, en, ca.",
    "param": "language",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NACCTPERSLANGINVAL1"
  }
}

Grants on a member that is not a `member`

{
  "error": {
    "type": "invalid_request_error",
    "code": "grants_only_for_member",
    "message": "Solo un miembro con rol member puede tener permisos por NIF: el titular y los administradores alcanzan todos los NIF de la cuenta.",
    "param": "level",
    "doc_url": "https://docs.factuarea.com/guides/errors#grants_only_for_member",
    "request_id": "req_01HKQS5NACCTGRANTSONLYMEM1"
  }
}

Grant on a tax ID outside the account or the credential scope

{
  "error": {
    "type": "invalid_request_error",
    "code": "grant_company_not_in_account",
    "message": "Ese NIF no pertenece a esta cuenta o queda fuera del ámbito de la credencial.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#grant_company_not_in_account",
    "request_id": "req_01HKQS5NACCTGRANTNIFOUTAC2"
  }
}

The account already has an external advisor

{
  "error": {
    "type": "invalid_request_error",
    "code": "external_advisor_already_assigned",
    "message": "Esta cuenta ya tiene un asesor externo: retíralo o quítale la marca antes de asignar otro.",
    "param": "external_advisor",
    "doc_url": "https://docs.factuarea.com/guides/errors#external_advisor_already_assigned",
    "request_id": "req_01HKQS5NACCTADVISORTAKEN03"
  }
}

Idempotency key reused with a different payload

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La Idempotency-Key 'order-2026-0001' ya se usó con un payload distinto.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01J8Y3M2Q40000000000000007"
  }
}

Idempotency-Key missing on an external-effect write

{
  "error": {
    "type": "invalid_request_error",
    "code": "idempotency_key_required",
    "message": "La operación «public-api.v1.invoices.send» exige la cabecera Idempotency-Key desde el 2026-10-01. Envía una clave única por operación (un UUID sirve) y, si reintenta, repite exactamente la misma clave para que la operación no se ejecute dos veces.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_required",
    "request_id": "req_01J8Y3M2Q40000000000000009"
  }
}

Rate limit exceeded

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

Too many authentication failures (temporary lockout)

{
  "error": {
    "type": "authentication_error",
    "code": "too_many_auth_failures",
    "message": "Has alcanzado el número máximo de intentos de autenticación fallidos. La API key queda bloqueada temporalmente. Reintenta tras el tiempo indicado en `Retry-After`.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#too_many_auth_failures",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVM"
  }
}

Too many concurrent uploads in flight

{
  "error": {
    "type": "rate_limit_error",
    "code": "upload_in_flight_budget_exceeded",
    "message": "Tu empresa tiene demasiadas subidas en curso a la vez: este archivo ocupa 10 MB y el margen simultáneo es de 120 MB. Espera a que terminen las subidas en marcha y vuelve a intentarlo dentro de 45 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#upload_in_flight_budget_exceeded",
    "request_id": "req_01HKQS5NUPLOADINFLIGHT005"
  }
}

Company-wide rate limit exceeded (all keys combined)

{
  "error": {
    "type": "rate_limit_error",
    "code": "company_rate_limit_exceeded",
    "message": "Tu empresa ha superado su límite conjunto de 900 peticiones por minuto, contando a la vez todas sus credenciales. Es un techo de la empresa, así que repartir el tráfico no lo eleva. Reintenta en 12 segundos, o solicita una ampliación de plan si necesitas más capacidad.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_rate_limit_exceeded",
    "request_id": "req_01HKQS5NCOMPANYRATELIMIT06"
  }
}

Company-wide monthly quota exhausted (all keys combined)

{
  "error": {
    "type": "rate_limit_error",
    "code": "company_monthly_quota_exceeded",
    "message": "Tu empresa ha agotado su cuota conjunta de 150000 peticiones de este mes, contando a la vez todas sus credenciales. Es un techo de la empresa, así que repartir el tráfico no lo eleva. El contador se reinicia el día 1 del mes siguiente; solicita una ampliación de plan si necesitas más volumen antes.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_monthly_quota_exceeded",
    "request_id": "req_01HKQS5NCOMPANYMONTHLY0007"
  }
}

Monthly quota of the API key exhausted

{
  "error": {
    "type": "rate_limit_error",
    "code": "monthly_quota_exceeded",
    "message": "Has agotado tu cuota mensual de 100000 requests. Mejora tu plan para obtener una cuota superior.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#monthly_quota_exceeded",
    "request_id": "req_01HKQS5NMONTHLYQUOTA000011"
  }
}

Portfolio rate limit exceeded (all tax IDs of the account combined)

{
  "error": {
    "type": "rate_limit_error",
    "code": "portfolio_rate_limit_exceeded",
    "message": "La cartera de tu cuenta ha superado su límite conjunto de 1800 peticiones por minuto, contando a la vez todos sus NIF. Es un techo de la cartera, así que repartir el tráfico entre NIF no lo eleva. Reintenta en 12 segundos, o solicita una ampliación de plan si necesitas más capacidad.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#portfolio_rate_limit_exceeded",
    "request_id": "req_01HKQS5NPORTFOLIORATE00012"
  }
}

Portfolio monthly quota exhausted (all tax IDs of the account combined)

{
  "error": {
    "type": "rate_limit_error",
    "code": "portfolio_monthly_quota_exceeded",
    "message": "La cartera de tu cuenta ha agotado su cuota conjunta de 300000 peticiones de este mes, contando a la vez todos sus NIF. Es un techo de la cartera, así que repartir el tráfico entre NIF no lo eleva. El contador se reinicia el día 1 del mes siguiente; solicita una ampliación de plan si necesitas más volumen antes.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#portfolio_monthly_quota_exceeded",
    "request_id": "req_01HKQS5NPORTFOLIOMONTH0013"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}

Send an account invitation

Authorization

Path Parameters

Headers

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`