Account

Accept a tax ID transfer

Accept a tax ID transfer with its secret: the tax ID moves to the account in the path. Irreversible.

  • The body carries only secret; requires Idempotency-Key (else 422 idempotency_key_required).
  • Plan gates run first, e.g. 402 additional_nif_plan_required, 402 payment_method_required.
  • 422 nif_transfer_invalid for an unusable secret; 422 nif_transfer_expired. Requires the nif_transfers:write scope, which * does not cover: the API key must list it explicitly.
post/accounts/{account}/nif-transfers/accept

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/accounts/{account}/nif-transfers/accept
  • 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).

Headers

Idempotency-Keystring required
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. 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.

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

secretstring required

Plaintext secret of the tax ID transfer, exactly as its issuance response returned it.

Response

Example response

{
  "data": {
    "expires_at": "2026-10-04T09:00:00+00:00",
    "issued_at": "2026-09-27T09:00:00+00:00"
  }
}

Changes

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