POST
/
api
/
v1
/
customers
/
save
{
  "customers": [
    {
      "account_type": "string",
      "alias_ids": [
        "string"
      ],
      "comment": "string",
      "company_name": "string",
      "contacts": "any",
      "date_of_birth": "string",
      "disabled": "boolean",
      "domicile_code": "string",
      "domicile_codes": [
        "string"
      ],
      "external_id": "string",
      "fields": "object",
      "first_name": "string",
      "kyc_level": "integer",
      "kyc_level_requested": "integer",
      "last_name": "string",
      "middle_name": "string",
      "nationality_code": "string",
      "nationality_codes": [
        "string"
      ],
      "phone": "string",
      "registration_number": "string",
      "review_groups": "any",
      "trading_name": "string",
      "variations": [
        {
          "_op": "string",
          "company_name": "string",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "trading_name": "string"
        }
      ]
    }
  ],
  "disable_risk_scan": "boolean",
  "relations": [
    {
      "child_customer_external_id": "string",
      "disabled": "boolean",
      "fields": "object",
      "parent_customer_external_id": "string",
      "relation_external_id": "string",
      "relation_type": "integer"
    }
  ],
  "verify_input": "boolean"
}
{
  "added": [
    {
      "customer_id": "string",
      "external_id": "string"
    }
  ],
  "detail": [
    {
      "errors": [
        {
          "detail": "string",
          "error": "string"
        }
      ],
      "external_id": "string",
      "warnings": [
        {
          "detail": "string",
          "error": "string"
        }
      ]
    }
  ],
  "status": "string",
  "verify_input": "boolean"
}

Body parameters

customers
SaveCustomerInput[]
disable_risk_scan
boolean

DO not execute scan and risk while importing; it will speedup the import but the risk and scan results will only be available on the next ongoing scan/risk process (usually over night). May be forced to true depending on how many customers are created/updated.

relations
SaveCustomerRelationInput[]
verify_input
boolean

True to just validate input without persisting data

Response body

added
AddedCustomer[]
detail
SaveCustomersResponseLineErrors[]
status
string
verify_input
boolean
{
  "customers": [
    {
      "account_type": "string",
      "alias_ids": [
        "string"
      ],
      "comment": "string",
      "company_name": "string",
      "contacts": "any",
      "date_of_birth": "string",
      "disabled": "boolean",
      "domicile_code": "string",
      "domicile_codes": [
        "string"
      ],
      "external_id": "string",
      "fields": "object",
      "first_name": "string",
      "kyc_level": "integer",
      "kyc_level_requested": "integer",
      "last_name": "string",
      "middle_name": "string",
      "nationality_code": "string",
      "nationality_codes": [
        "string"
      ],
      "phone": "string",
      "registration_number": "string",
      "review_groups": "any",
      "trading_name": "string",
      "variations": [
        {
          "_op": "string",
          "company_name": "string",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "trading_name": "string"
        }
      ]
    }
  ],
  "disable_risk_scan": "boolean",
  "relations": [
    {
      "child_customer_external_id": "string",
      "disabled": "boolean",
      "fields": "object",
      "parent_customer_external_id": "string",
      "relation_external_id": "string",
      "relation_type": "integer"
    }
  ],
  "verify_input": "boolean"
}
{
  "added": [
    {
      "customer_id": "string",
      "external_id": "string"
    }
  ],
  "detail": [
    {
      "errors": [
        {
          "detail": "string",
          "error": "string"
        }
      ],
      "external_id": "string",
      "warnings": [
        {
          "detail": "string",
          "error": "string"
        }
      ]
    }
  ],
  "status": "string",
  "verify_input": "boolean"
}