Starts a new self sign up process. Returns a token and required fields.

GET /api/cp/signup/start

Query parameters

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Starts a new self sign up process. Returns a token and required fields.

    Hide response attributes Show response attributes object
    • id integer
    • token string
    • public_session_token string
    • invite_code object
      Hide invite_code attributes Show invite_code attributes object
      • id integer
      • token string
      • log_book_entry_content_type string
      • created string(date-time)
      • updated string(date-time)
      • deleted boolean
      • name string
      • image_url string
    • person_first_name string
    • person_last_name string
    • person_email string
    • person_phone string
    • company_name string
    • company_email string
    • company_phone string
    • company_address string
    • company_address_street_level string
    • company_address_co string
    • company_address_city string
    • company_address_zip string
    • company_address_country string
    • person_address string
    • person_address_street_level string
    • person_address_co string
    • person_address_city string
    • person_address_zip string
    • person_address_country string
    • person_birthday string(date-time)
    • person_gender string
    • person_grade_level integer
    • person_school_class string
    • person_category string
    • ticket_ticket_type string
    • ticket_issuetype string
    • ticket_issue_category string
    • require_sepa boolean
    • require_address boolean
    • require_company_name string
    • require_person_address boolean
    • require_person_birthday boolean
    • require_person_gender boolean
    • require_person_phone string
    • require_ticket boolean
    • additional_people array[object]
      Hide additional_people attributes Show additional_people attributes object
      • id integer
      • person_first_name string
      • person_last_name string
      • person_email string
      • person_phone string
      • person_address string
      • person_address_street_level string
      • person_address_co string
      • person_address_city string
      • person_address_zip string
      • person_address_country string
      • person_birthday string(date-time)
      • person_gender string
      • person_grade_level integer
      • person_school_class string
      • person_category string
      • processed_person_id string
    • processed_company_number string
    • processed_company_id string
    • processed_person_id string
    • processed_user_id string
    • created string(date-time)
    • updated string(date-time)
    • payment_owner string
    • payment_institution string
    • payment_bic string
    • payment_iban string
    • payment_mandate string
    • payment_mandate_sign_date string(date-time)
    • payment_mandate_valid_until_date string(date-time)
GET /api/cp/signup/start
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/cp/signup/start' \
 --header "x-session-token: $API_KEY"
Response examples (200)
{
  "id": 42,
  "token": "string",
  "public_session_token": "string",
  "invite_code": {
    "id": 42,
    "token": "string",
    "log_book_entry_content_type": "string",
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "deleted": true,
    "name": "string",
    "image_url": "string"
  },
  "person_first_name": "string",
  "person_last_name": "string",
  "person_email": "string",
  "person_phone": "string",
  "company_name": "string",
  "company_email": "string",
  "company_phone": "string",
  "company_address": "string",
  "company_address_street_level": "string",
  "company_address_co": "string",
  "company_address_city": "string",
  "company_address_zip": "string",
  "company_address_country": "string",
  "person_address": "string",
  "person_address_street_level": "string",
  "person_address_co": "string",
  "person_address_city": "string",
  "person_address_zip": "string",
  "person_address_country": "string",
  "person_birthday": "2025-05-04T09:42:00Z",
  "person_gender": "string",
  "person_grade_level": 42,
  "person_school_class": "string",
  "person_category": "string",
  "ticket_ticket_type": "string",
  "ticket_issuetype": "string",
  "ticket_issue_category": "string",
  "require_sepa": true,
  "require_address": true,
  "require_company_name": "string",
  "require_person_address": true,
  "require_person_birthday": true,
  "require_person_gender": true,
  "require_person_phone": "string",
  "require_ticket": true,
  "additional_people": [
    {
      "id": 42,
      "person_first_name": "string",
      "person_last_name": "string",
      "person_email": "string",
      "person_phone": "string",
      "person_address": "string",
      "person_address_street_level": "string",
      "person_address_co": "string",
      "person_address_city": "string",
      "person_address_zip": "string",
      "person_address_country": "string",
      "person_birthday": "2025-05-04T09:42:00Z",
      "person_gender": "string",
      "person_grade_level": 42,
      "person_school_class": "string",
      "person_category": "string",
      "processed_person_id": "string"
    }
  ],
  "processed_company_number": "string",
  "processed_company_id": "string",
  "processed_person_id": "string",
  "processed_user_id": "string",
  "created": "2025-05-04T09:42:00Z",
  "updated": "2025-05-04T09:42:00Z",
  "payment_owner": "string",
  "payment_institution": "string",
  "payment_bic": "string",
  "payment_iban": "string",
  "payment_mandate": "string",
  "payment_mandate_sign_date": "2025-05-04T09:42:00Z",
  "payment_mandate_valid_until_date": "2025-05-04T09:42:00Z"
}