> ## Documentation Index
> Fetch the complete documentation index at: https://developer.surense.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a customer
Example:
```json
{
"idType": 1,
"idNumber": "999104151",
"idCardIssueDate": "2010-09-15",
"firstName": "שם פרטי",
"lastName": "משפחה",
"phoneNumber1": null,
"phoneNumber2": null,
"email": null,
"managerId": "534a38c2-ac29-460f-9441-9fcd05d1a3cb",
"sourceId": null
}
```
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "API",
"description": "Surense API",
"termsOfService": "https://static.surense.com/terms.htm",
"contact": {
"name": "API Support",
"email": "contact@surense.com"
},
"version": "1"
},
"servers": [
{
"url": "https://api.surense.com/api/v1",
"description": "Production"
}
],
"paths": {
"/customers": {
"post": {
"tags": [
"Customers"
],
"summary": "Create a customer",
"operationId": "createCustomer",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"customers:create"
]
}
]
}
}
},
"components": {
"schemas": {
"CreateCustomerRequest": {
"type": "object",
"description": "Request to create a new customer",
"properties": {
"forceCreation": {
"type": "boolean",
"description": "Force creation even if conflicts exist",
"example": false
},
"idType": {
"type": "integer",
"format": "int32",
"description": "Customer Identity Type:
1 - ת.ז
2 - דרכון
3 - רישיון נהיגה
4 - אחר
5 - ח.פ
6 - ח.צ",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6"
],
"example": 1
},
"idNumber": {
"type": "string",
"description": "ID number",
"example": 123456789
},
"idCardIssueDate": {
"type": "string",
"description": "ID card issue date",
"example": "2020-01-15"
},
"firstName": {
"type": "string",
"description": "First name",
"example": "John"
},
"shortName": {
"type": "string",
"description": "Short name",
"example": "Johnny"
},
"lastName": {
"type": "string",
"description": "Last name",
"example": "Doe"
},
"maidenName": {
"type": "string",
"description": "Maiden name",
"example": "Smith"
},
"engFirstName": {
"type": "string",
"description": "English first name",
"example": "John"
},
"engLastName": {
"type": "string",
"description": "English last name",
"example": "Doe"
},
"phoneNumber1": {
"type": "string",
"description": "Phone number 1",
"example": "+972501234567"
},
"phoneNumber2": {
"type": "string",
"description": "Phone number 2",
"example": "+972507654321"
},
"phoneNumber3": {
"type": "string",
"description": "Phone number 3",
"example": "+972509876543"
},
"faxNumber": {
"type": "string",
"description": "Fax number",
"example": "+972501234567"
},
"email1": {
"type": "string",
"description": "Email address 1",
"example": "john.doe@example.com"
},
"email2": {
"type": "string",
"description": "Email address 2",
"example": "john.work@example.com"
},
"gender": {
"type": "integer",
"format": "int32",
"description": "Gender:
1 - לא מוגדר
2 - זכר
3 - נקבה",
"enum": [
"1",
"2",
"3"
],
"example": 2
},
"birthDate": {
"type": "string",
"description": "Birth date",
"example": "1990-01-15"
},
"death": {
"type": "boolean",
"description": "Death status",
"example": false
},
"deathDate": {
"type": "string",
"description": "Death date",
"example": "2023-12-31"
},
"maritalStatus": {
"type": "integer",
"format": "int32",
"description": "Marital Status:
1 - Single
2 - Married
3 - Divorced
4 - Widowed
5 - Cohabiting",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"example": 2
},
"profession": {
"type": "string",
"description": "Profession",
"example": "Software Engineer"
},
"employmentStatus": {
"type": "integer",
"format": "int32",
"description": "Employment Status:
1 - שכיר/ה
2 - עצמאי/ת
3 - שכיר/ה ועצמאי/ת
4 - שכיר/ה בעל/ת שליטה
5 - לא מועסק/ת
6 - שכיר/ה בעל/ת שליטה ועצמאי/ת
7 - פנסיונר/ית",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7"
],
"example": 1
},
"managerId": {
"type": "string",
"description": "Manager ID",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"statusId": {
"type": "string",
"description": "Customer status ID",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"sourceId": {
"type": "string",
"description": "Customer source ID",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"classId": {
"type": "string",
"description": "Customer class ID",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"sensitive": {
"type": "boolean",
"description": "Sensitive customer flag",
"example": false
},
"mailingStatus": {
"type": "integer",
"format": "int32",
"description": "Mailing Status:
1 - אושר דיוור
2 - לא אושר דיוור
3 - הוסר מדיוור
4 - לא התבקש אישור",
"enum": [
"1",
"2",
"3",
"4"
],
"example": 1
},
"mailingStatusDate": {
"type": "string",
"description": "Mailing status date",
"example": "2024-01-15T10:00:00Z"
},
"street": {
"type": "string",
"description": "Street name",
"example": "Main Street"
},
"streetNumber": {
"type": "string",
"description": "Street number",
"example": 123
},
"apartmentNumber": {
"type": "string",
"description": "Apartment number",
"example": "5A"
},
"postalBox": {
"type": "integer",
"format": "int32",
"description": "Postal box number",
"example": 1234
},
"city": {
"type": "string",
"description": "City",
"example": "Tel Aviv"
},
"postalCode": {
"type": "integer",
"format": "int32",
"description": "Postal code",
"example": 12345
},
"country": {
"type": "string",
"description": "Country",
"example": "Israel"
},
"usCitizen": {
"type": "boolean",
"description": "US citizen status",
"example": false
},
"foreignTaxResidency": {
"type": "boolean",
"description": "Foreign tax residency status",
"example": false
},
"engAddress": {
"type": "string",
"description": "English address",
"example": 123
},
"kupatHolim": {
"type": "integer",
"format": "int32",
"description": "Kupat Holim:
1 - כללית
2 - מכבי
3 - מאוחדת
4 - לאומית
5 - צה\"לית",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"example": 1
},
"kupatHolimComplementary": {
"type": "integer",
"format": "int32",
"description": "Kupat Holim Complementary:
10 - כללית מושלם זהב
11 - כללית פלטינום
20 - מכבי שלי
21 - מכבי כסף
22 - מכבי זהב
30 - מאוחדת עדיף
31 - מאוחדת שיא
40 - לאומית כסף
41 - לאומית זהב",
"enum": [
"10",
"11",
"20",
"21",
"22",
"30",
"31",
"40",
"41"
],
"example": 10
},
"height": {
"type": "integer",
"format": "int32",
"description": "Height in cm",
"example": 175
},
"weight": {
"type": "integer",
"format": "int32",
"description": "Weight in kg",
"example": 70
},
"smoker": {
"type": "boolean",
"description": "Smoker status",
"example": false
},
"cigarettesCountPerDay": {
"type": "integer",
"format": "int32",
"description": "Cigarettes count per day",
"example": 10
},
"drugs": {
"type": "string",
"description": "Drugs information",
"example": "None"
},
"surgeries": {
"type": "string",
"description": "Surgeries information",
"example": "None"
},
"hospitalizations": {
"type": "string",
"description": "Hospitalizations information",
"example": "None"
},
"backgroundDiseases": {
"type": "string",
"description": "Background diseases",
"example": "None"
},
"bankAccountType": {
"type": "string",
"description": "Bank account type",
"example": "CHECKING"
},
"bankCode": {
"type": "integer",
"format": "int32",
"description": "Bank code",
"example": 10
},
"bankBranchCode": {
"type": "integer",
"format": "int32",
"description": "Bank branch code",
"example": 123
},
"bankAccountNumber": {
"type": "string",
"description": "Bank account number",
"example": 123456789
},
"notes": {
"type": "string",
"description": "Notes",
"example": "Important customer notes"
},
"notesAlert": {
"type": "boolean",
"description": "Notes alert",
"example": true
}
}
}
},
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://auth.surense.com/authorize",
"tokenUrl": "https://auth.surense.com/oauth/token",
"scopes": {
"openid": "OpenID",
"profile": "Profile",
"global:export": "Export"
}
}
}
}
}
}
}
```