---
title: "Redeem an invitation code. NO authentication (1.62.0)."
method: POST
path: "/identity/invitations/redeem"
---

# Redeem an invitation code. NO authentication (1.62.0).

`POST /identity/invitations/redeem`

## Request

- Base URL: `https://forbiz.io/api/public/agent`
- URL: `https://forbiz.io/api/public/agent/identity/invitations/redeem`
- Auth: none required

Body: code, agent_name, client_name?. Creates an agent identity in the inviter's workspace with exactly the invitation's capabilities and scopes and returns credential { api_key (fbzr_ renewal credential), token_type, header, scopes, capabilities, expires_at, renewable, token_exchange } once, plus handoff. Single use: 410 INVITATION_ALREADY_USED | INVITATION_EXPIRED | INVITATION_REVOKED with a plain reason; 404 INVITATION_NOT_FOUND; 429 REDEEM_RATE_LIMITED (per IP and per code).

## Request body

- object
  - `code` string
  - `agent_name` string
  - `client_name` string

## Response `201`

Redeemed

- object
  - `agent` object
  - `credential` object
  - `handoff` object

---

[API](https://skmtc.dev/forbiz/apis/forbiz-external-agent-api.md) · [All operations](https://skmtc.dev/forbiz/apis/forbiz-external-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/forbiz/apis/forbiz-external-agent-api/revisions/e5b10d59dc5f?raw)