Account

Change the tax IDs an API key reaches

Replace the tax-ID scope of an API key with scoped_company_ids, the complete resulting list (not a delta).

  • The new scope can never exceed yours; a scope the plan of any tax ID disallows returns 422.
  • Test keys and browser-published keys cannot change scope.
  • Uncovered scopes return 403 insufficient_scope.
patch/accounts/{account}/api-keys/{api_key}/nif-scope

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/accounts/{account}/api-keys/{api_key}/nif-scope
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

accountstring uuid required

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

api_keystring uuid required

Public identifier (UUID v7) of the API key.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

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.

Factuarea-Versionstring date
Example:2026-06-01

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.

Request body

scoped_company_idsstring[] required

Complete resulting list of public identifiers (UUID v7) of the companies of your account the key will reach. It replaces the current scope.

Response

Example response

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b0c",
    "object": "api_key_nif_scope",
    "scope": [
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
        "tax_id": "B12345674",
        "name": "Acme Soluciones SL",
        "access_level": "operate"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.