Invites

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argyle9a25/json-schema/argyle9a25-client-invite-session-schema.json",
  "title": "Invites",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argyle9a25-sessions-api-openapi.yml#/components/schemas/ClientInviteSession",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the [invite](/api-reference/invites)."
    },
    "user": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the user associated with the invite."
    },
    "type": {
      "type": "string",
      "enum": [
        "invite"
      ],
      "description": "Session type."
    },
    "configuration": {
      "$ref": "#/$defs/ClientInviteSessionConfiguration"
    },
    "link": {
      "type": "string",
      "format": "uri",
      "description": "URL sent to the user by email or SMS."
    },
    "invite": {
      "$ref": "#/$defs/ClientInviteSessionInvite"
    }
  },
  "$defs": {
    "ClientInviteSessionConfiguration": {
      "type": "object",
      "properties": {
        "flow_id": {
          "type": "string",
          "description": "Flow ID supplied for the invite. The resolved experience also depends on whether the flow matches the user's wholesale or retail context."
        },
        "items": {
          "type": "array",
          "description": "Items available in Link.",
          "items": {
            "type": "string"
          }
        },
        "reply_to": {
          "type": [
            "string",
            "null"
          ],
          "format": "email",
          "description": "Reply-To address for the invite email."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "format": "email",
          "description": "Invite recipient email address."
        },
        "phone_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "Invite recipient phone number."
        }
      }
    },
    "ClientInviteSessionDelivery": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique ID of the [invite](/api-reference/invites)."
        },
        "method": {
          "type": "string",
          "enum": [
            "email",
            "sms"
          ],
          "description": "Invite delivery method."
        },
        "status": {
          "type": "string",
          "enum": [
            "sent",
            "delivered",
            "undelivered",
            "opened"
          ],
          "description": "Invite delivery status."
        },
        "sent_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was sent."
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the delivery status was last updated."
        }
      }
    },
    "ClientInviteSessionInvite": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "sent",
            "initiated",
            "attempted",
            "completed",
            "revoked"
          ],
          "description": "Invite status. Use verification statuses to determine whether all verifications are complete.\n\n- `sent` - The invite was sent.\n- `initiated` - The user opened the invite and entered Link, but has not submitted login credentials, uploaded documents, or completed a response form.\n- `attempted` - The user submitted login credentials without connecting an account, or completed only a response form.\n- `completed` - The user connected an account or uploaded a document. Other verifications for the user may still be active.\n- `revoked` - The invite was revoked and its link can no longer be used.\n"
        },
        "deliveries": {
          "type": "array",
          "description": "Invite deliveries.",
          "items": {
            "$ref": "#/$defs/ClientInviteSessionDelivery"
          }
        },
        "invited_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was sent."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was created."
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was last updated."
        }
      }
    }
  }
}