CapitalFlow icon

CapitalFlow

Interact with the CapitalFlow API

Actions38

Customer → Create

AI-generated

Summary

Create a new customer record in the CapitalFlow system by supplying required first and last names, plus optional personal, address, occupational, health, tax, education, bank, and identity card details.

Inputs

  • Firstname (required) — Customer's first name.
  • Lastname (required) — Customer's last name.
  • Additional Fields — Optional customer details including address (city, state, street, zipcode), contact email and phone, customer role within household (main, partner, child), date of birth, family living situation, form of address, household ID (required if role is partner or child), marital status, nationality, place of birth, and salutation.
  • Occupation Info — Optional occupational details such as career level, compensation information, employer (federal state), employment type, income figures, job title, labor union, occupation type, official status, personnel level and responsibility, provider, public service status, and supervisory role.
  • Health Info — Optional health-related data including dangerous hobbies, health insurance details and type, height, smoking status and duration of non-smoking, work activity percentages, travel activity, and weight.
  • Tax Info — Optional tax information such as children allowance and count, church tax status, social security number, spouse factor, tax class, and tax ID.
  • Education Info — Optional education details like university degree type, vocational training definition, field of study, highest diploma, trained in field, and vocational training status.
  • Bank Info — Optional bank data including bank name, BIC, and IBAN.
  • Identity Card Info — Optional identity card information such as date of issuing, card number, issuing authority, and validity.

Output shape

a single record representing the created customer

The output contains the full customer object as created by the API. Required fields are first and last name. Roles of partner or child require a household ID; main customers create a new household automatically. The API requires the address state field when address information is provided.

Links

Discussion