Mislaka-API · Developer Documentation

REST API · v1.0.0

Mislaka-API Documentation

The Mislaka-API lets you send transaction calls to Swiftness through a simple REST API — pension clearinghouse requests, insurance mountain (Har Bituach), policy copies and more, all from one endpoint.

i Nobel Digital is the authorized distributor of Swiftness. Website: nobel.co.il · API Version: 1.0.0

Swiftness Nobel Digital

Registration

Swiftness services can be accessed by completing the following steps:

Active insurance license
Registered at Swiftness LTD.
Apply a permission form signed by us & you to Swiftness LTD.
Credit card to purchase a subscription plan

Create an account →

Pricing

Simple subscription plan with pay-per-use requests.

Monthly License

₪320 / month

Per Request

₪3.5 / request & handling

Integration

Let's Talk

Installation, CRM connection, automation & custom services.

Authentication

To use the API, authenticate every request by sending your API key as the value of the token header.

An API token is generated once your account has been verified. You can regenerate your API key at any time from the settings page.

Header

token: API_KEY_HERE

Headers

Make sure the following content-type headers are present on every request.

Required Headers

Accept: application/json
Content-Type: application/json

Base URI

Mislaka's API is hosted on the following base URI. All endpoint paths in this reference are relative to it.

Base URL

https://mislaka-api.co.il/api

Errors

Mislaka uses conventional HTTP response codes to indicate the success or failure of an API request. The table below summarizes the typical response codes.

Code	Description
200	Everything is OK.
400	Valid data was given but the request has failed.
401	No valid API key was given.
404	The requested resource could not be found.
422	The payload has missing required parameters or invalid data was given.
429	Too many attempts.
500	Request failed due to an internal error in Mislaka.
503	Mislaka is offline for maintenance.

Rate Limit

To prevent overloading of our servers and to guard against flood attacks, we apply a limit of 100 requests per minute. Exceeding the limit returns a 429 response.

API History

Inside the dashboard you have logs for each API request. You can trace the following data for every call:

Datetime
Method
Endpoint
Payload
Sender IP
Transaction ID

Leads Pages

Hosted lead-collection pages that capture client details and signed forms directly from the field.

Get All Pages

Returns every leads page configured on your account, including the forms attached to each page and its routing settings.

GET/api/leads-pages

Response

[
  {
    "page_name": "",
    "status": "Active / Inactive",
    "forms": ["נספח א","הר הביטוח","פוליסות מחברות הביטוח"],
    "send_9100": true,
    "redirect_url": "",
    "webhook_url": ""
  }
]

Get Records List

Returns the lead records captured across your pages, including the client details, attached form IDs and webhook delivery status.

GET/api/leads-pages/records

Response

[
  {
    "first_name": "",
    "last_name": "",
    "id_number": "",
    "email": "",
    "mobile_phone": "",
    "ip_address": "",
    "user_agent": "",
    "forms": {
      "form_a_id": "",
      "form_harb_id": "",
      "form_insurance_polisot": ""
    },
    "page_url": "",
    "status": "Active / Inactive",
    "params": "",
    "transaction_id": "",
    "send_9100": "",
    "redirect_url": "",
    "webhook_url": "",
    "webhook_response_code": 200,
    "webhook_response_content": ""
  }
]

Create Lead Page For Person

Creates a personalized lead page for a single client and optionally informs them and kicks off processes automatically.

POST/api/leads-page/create

Key	Type	Req.	Description
`firstName`	String	No
`lastName`	String	No
`personId`	String	Yes	ID number — 9 digits
`mobile`	String	No	Required only if `inform` is true
`email`	String	No	Required only if `inform` is true
`formA`	Boolean	No
`formHarb`	Boolean	No
`formInsurancePolisot`	Boolean	No
`send9100Process`	Boolean	No
`sendHarbProcess`	Boolean	No
`sendPolisotProcess`	Boolean	No
`birthDate`	Date	No
`issueDate`	Date	No
`redirectUrl`	String	No
`inform`	Boolean	No
`webhookUrl`	String	No
`senderId`	String	No

Payload

{
  "firstName": "ישראל",
  "lastName": "ישראלי",
  "personId": "",
  "mobile": "",
  "email": "",
  "formA": false,
  "formHarb": true,
  "formInsurancePolisot": false,
  "send9100Process": false,
  "sendHarbProcess": true,
  "sendPolisotProcess": false,
  "birthDate": "1980-12-01",
  "issueDate": "1980-12-01",
  "redirectUrl": "",
  "inform": false,
  "webhookUrl": "",
  "senderId": ""
}

Forms

Send forms to clients for remote digital signature via Email, SMS or both — then retrieve the signed files.

Send 'Form A' To Client

Sends Form A to a client for signature. Optionally fires the 9100 information request automatically once the form is signed.

POST/api/forms

Key	Type	Req.	Description
`sender_id`	String	Yes	ID number of the sender
`type`	String	Yes	"formA"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`city_name`	String	Yes	City of client
`address`	String	Yes	Street of client
`house_number`	String	No	House number of client
`mobile`	String	If SMS	Mobile number, if sending by SMS
`email`	String	If Email	Email address, if sending by Email
`send_type`	enum	Yes	email / sms / email_sms
`send_9100_when_signed`	Boolean	Yes	Auto-send 9100 when form is signed

Payload

{
  "sender_id": "",
  "type": "formA",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "city_name": "",
  "address": "",
  "house_number": "",
  "mobile": "",
  "email": "",
  "send_type": "email",
  "send_9100_when_signed": true
}

Response

{
  "message": "Form sent to client",
  "formId": "xxxx-xxxx-xxxx-xxxx"
}

Send 'Har Bituach' To Client

Sends the insurance-mountain (Har Bituach) authorization form to a client for signature.

POST/api/forms

Key	Type	Req.	Description
`sender_id`	String	Yes	ID number of the sender
`type`	String	Yes	"harb"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`mobile`	String	If SMS	Mobile number, if sending by SMS
`email`	String	If Email	Email address, if sending by Email
`send_type`	enum	Yes	email / sms / email_sms
`harb_issue_date`	Date	No	Issue date of ID card · format d/m/Y
`harb_birthdate`	Date	No	Client birth date · format d/m/Y
`harb_family`	Boolean	No

Payload

{
  "sender_id": "",
  "type": "harb",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "mobile": "",
  "email": "",
  "send_type": "email",
  "harb_issue_date": "2024-12-31",
  "harb_birthdate": "2024-12-31",
  "harb_family": ""
}

Response

{
  "message": "Form sent to client",
  "formId": "xxxx-xxxx-xxxx-xxxx"
}

Send 'Insurance Polisot Copy' To Client

Sends a policy-copy authorization form to a client, scoped to a specific manufacturer.

POST/api/forms

Key	Type	Req.	Description
`sender_id`	String	Yes	ID number of the sender
`type`	String	Yes	"harb"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`mobile`	String	If SMS	Mobile number, if sending by SMS
`email`	String	If Email	Email address, if sending by Email
`send_type`	enum	Yes	email / sms / email_sms
`manager_id`	String	Yes	The ID number of the manufacturer

Payload

{
  "sender_id": "",
  "type": "harb",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "mobile": "",
  "email": "",
  "send_type": "email",
  "manager_id": "required"
}

Response

{
  "message": "Form sent to client",
  "formId": "xxxx-xxxx-xxxx-xxxx"
}

Get Form

Retrieves the full status and signature metadata of a form, including the linked 9100 transaction if it was generated.

GET/api/forms/{formId}

Response

{
  "form_id": "",
  "person_id_number": "",
  "client_first_name": "",
  "client_last_name": "",
  "client_email": "",
  "client_phone": "",
  "client_ip": "",
  "client_browser": "",
  "client_platform": "",
  "signed_date": "",
  "sent_by": "SMS",
  "status": "Signed",
  "created": "2024-02-02T14:28:51.000000Z",
  "updated": "2024-02-02T16:39:34.000000Z",
  "9100_created": true,
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx"
}

Get File

Returns the signed form file content for download.

GET/forms/{formId}/files/

Response

Returns the file content for downloading (PDF)

Delete Files

Deletes the form's stored files.

DEL/forms/{formId}/files/

! This method will also delete the 9100 Transaction files if they exist.

Response

{
  "message": "FormA File deleted successfully",
  "formId": "xxxx-xxxx-xxxx-xxxx"
}

Transactions

Create and track requests to the pension clearinghouse and Har Bituach — all transaction types post to a single /api/transaction endpoint, distinguished by the type field.

Create Information Request בקשת מיידעים — טרום ייעוץ

Sends a 9100 pre-advisory information request to the Mislaka clearinghouse.

POST/api/transaction

Key	Type	Req.	Description
`type`	String	Yes	"9100"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`signed_date`	Date	Yes	When the client signed · e.g. 31/12/2023
`city_name`	String	Yes	City of client
`address`	String	Yes	Street of client
`house_number`	String	Yes	House number of client
`sender_id`	String	No

Payload

{
  "type": "9100",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "signed_date": "31/12/2023",
  "city_name": "",
  "address": "",
  "house_number": "",
  "sender_id": ""
}

Response

{
  "message": "File was Sent To Mislaka",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Create Power of Attorney בקשת מינוי סוכן

Submits a 1700 agent-appointment (power of attorney) request to a specific insurance manufacturer.

POST/api/transaction

Key	Type	Req.	Description
`type`	String	Yes	"1700"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`signed_date`	Date	Yes	When the client signed · e.g. 31/12/2023
`city_name`	String	Yes	City of client
`address`	String	Yes	Street of client
`house_number`	String	Yes	House number of client
`form_type`	String	Yes	2 = B1, 3 = B2
`manufacturer`	Number	Yes	Insurance manufacturer company ID number
`agent_number`	String	No	Internal agent number at the manufacturer
`power_of_attorney_file_url`	URL	Yes	Link to the power of attorney file — PDF / image
`identification_file_url`	URL	Yes	Link to the identification file — PDF / image

Payload

{
  "type": "1700",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "signed_date": "31/12/2023",
  "city_name": "",
  "address": "",
  "house_number": "",
  "form_type": "3",
  "manufacturer": 123123123,
  "agent_number": "",
  "power_of_attorney_file_url": "http://...",
  "identification_file_url": "http://...",
  "product_data": [
    {
      "agent_number": "",
      "product_code": "",
      "client_account_number_in_product": ""
    }
  ]
}

Response

{
  "message": "File was Sent To Mislaka",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Create Policy Copy בקשת העתקי פוליסות

Requests copies of insurance policies from a manufacturer, optionally sending a signature request to the client first and including family members.

POST/api/transaction

Key	Type	Req.	Description
`type`	String	Yes	"policy_copy"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`email_address`	Email	No	Only if sending a signature request
`phone`	String	No	Only if sending a signature request
`manufacturer`	Number	Yes	Insurance manufacturer company ID number
`send_form_to_client_signature`	Boolean	No	Send a signature request to client?
`send_signature_type`	enum	No	If signature request is true: email/sms/both
`form_file_url`	URL	No	Required only if not sending a signature request
`family_members`	Array	No	To get policies of family members — name & person id
`products`	Array	Yes	Code of every policy to retrieve
`sender_id`	String	No

Payload

{
  "type": "policy_copy",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "email_address": "",
  "phone": "",
  "manufacturer": 123123123,
  "send_form_to_client_signature": true,
  "send_signature_type": "email/sms/both",
  "form_file_url": "http://...",
  "family_members": [
    { "name": "", "person_id_number": "" }
  ],
  "products": [
    {
      "agent_number": "",
      "product_code": "",
      "client_account_number_in_product": ""
    }
  ],
  "sender_id": ""
}

Response

{
  "message": "File was Sent",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Create Employee Information בקשת מידע למעסיק עבור עובד

Submits a 9401 employer-information request for a specific employee.

POST/api/transaction

Key	Type	Req.	Description
`type`	String	Yes	"9401"
`employee_first_name`	String	Yes	First name of employee
`employee_last_name`	String	Yes	Last name of employee
`employee_person_id_number`	String	Yes	ID number — 9 digits
`employee_email`	Email	Yes	Email of the employee
`employee_phone`	String	Yes	Phone number of the employee
`employer_type`	String	Yes	Business ID type · 1 = ח.פ, 3 = ת.ז
`employer_id`	String	Yes	Business identification number
`employer_name`	String	Yes	Business name
`sender_id`	String	No

Payload

{
  "type": "9401",
  "employee_first_name": "",
  "employee_last_name": "",
  "employee_person_id_number": "",
  "employee_email": "",
  "employee_phone": "",
  "employer_type": "",
  "employer_id": "",
  "employer_name": "",
  "sender_id": ""
}

Response

{
  "message": "File was Sent To Mislaka",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Create Har Bituach Request בקשה לקבלת הר הביטוח

Requests an insurance-mountain (Har Bituach) report. Supports a regular request or an under-age request that includes children.

POST/api/transaction

Key	Type	Req.	Description
`type`	String	Yes	"harBituach"
`harb_type`	String	Yes	regular / underAge
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number (requester, if under-age)
`birth_date`	Date	Yes	Birth date · format d/m/Y
`id_issue_date`	Date	Yes	ID card issue date · format d/m/Y
`children`	Array	No	Up to 1 child per request (3 with `basket`)
`child_id`	String	No	ID number — 9 digits
`child_bd`	Date	No	Birth date · format d/m/Y
`send_form_to_client_signature`	Boolean	No
`send_signature_type`	enum	No	sms \| email \| both
`mobile_phone`	String	No	Required if signature type is sms or both
`email`	Email	No	Required if signature type is email or both
`sender_id`	String	No	Uses the default if empty
`callback_url`	URL	No	Overrides the default webhook if set

Payload

{
  "type": "harBituach",
  "harb_type": "regular", // default 'regular' - or underAge
  "first_name": "",
  "last_name": "",
  "person_id_number": "", // required
  "birth_date": "",       // required: d/m/Y
  "id_issue_date": "",    // required: d/m/Y
  "mobile_phone": "",     // required if signature is sms or both
  "email": "",            // required if signature is email or both
  "children": [           // only for harb_type 'underAge'
    {
      "child_id": "",     // required
      "child_bd": ""      // required
    }
  ],
  "send_form_to_client_signature": "",
  "send_signature_type": "", // sms / email / both
  "sender_id": "",
  "callback_url": ""
}

Response

{
  "message": "Sent To Har HaBituach",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Create Car Insurance History בקשה לקבלת היעדר תביעות — עבר ביטוחי לרכב

Requests a no-claims / insurance-history report for a vehicle.

POST/api/transaction

Key	Type	Req.	Description
`type`	String	Yes	"CarInsuranceHistory"
`first_name`	String	Yes	First name of client
`last_name`	String	Yes	Last name of client
`person_id_number`	String	Yes	ID number — 9 digits
`birth_date`	Date	Yes	Birth date · format d/m/Y
`id_issue_date`	Date	Yes	ID card issue date · format d/m/Y
`car_number`	Number	Yes	Vehicle registration number
`send_form_to_client_signature`	Boolean	No
`send_signature_type`	enum	No	sms \| email \| both
`mobile_phone`	String	No
`email`	Email	No
`sender_id`	String	No	Uses the default if empty
`callback_url`	URL	No	Overrides the default webhook if set

Payload

{
  "type": "CarInsuranceHistory",
  "first_name": "",
  "last_name": "",
  "person_id_number": "",
  "birth_date": "",
  "id_issue_date": "",
  "car_number": "",
  "send_form_to_client_signature": "",
  "send_signature_type": "",
  "mobile_phone": "",
  "email": "",
  "sender_id": "",
  "callback_url": ""
}

Response

{
  "message": "Sent To Har HaBituach",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Get Transaction

Retrieves the current status and summary of a transaction by its ID.

GET/api/transaction/{transactionId}

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx",
  "status": "finished",
  "action_code": "9100",
  "person_id_number": "123456789",
  "amount_of_responses": "86",
  "created": "",
  "updated": ""
}

Get Har HaBituach Data קבלת מידע מהר הביטוח

Returns the parsed Har Bituach data for a completed transaction.

GET/api/transaction/harBituach/{transactionId}

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "status": "Completed",
  "person_id_number": "123456789",
  "data": [ ... Data ... ]
}

Get Car Insurance History Data היעדר תביעות

Returns the parsed no-claims / car insurance history data for a completed transaction.

GET/api/transaction/carInsuranceHistory/{transactionId}

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "status": "Completed",
  "person_id_number": "123456789",
  "data": [ ... Data ... ]
}

Get Employee Information (9401)

Returns the employer-information results for a completed 9401 transaction.

GET/api/transaction/{transactionId}/employee-info

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx",
  "status": "Completed",
  "action_code": 9401,
  "person_id_number": "123456789",
  "employeeInfo": [ ... Data ... ]
}

Get Files

Downloads the transaction files in the requested format.

GET/transaction/{transactionId}/files/{fileType}

Key	Acceptable Values
`fileType`	PDF
`fileType`	XLS
`fileType`	ZIP

Response

Returns the file content for downloading

Get Mislaka Productions Files

Returns the production files from Swiftness, either as the original dat files or in our JSON format.

GET/production/{transactionId}/files/dat/{time}

Key	Value	Description
`fileType`	dat	Original files
`fileType`	json	Our format

Response

{
  "link": "..."
}

Delete Files

Deletes the stored files for a transaction.

DEL/transaction/{transactionId}/files/

! This method will also delete the Form A file if it exists.

Response

{
  "message": "Files deleted successfully",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Masked Record

Masks the personally-identifiable information (PII) stored for a transaction.

GET/api/transaction/{transactionId}/masked

Example of masked data

Key	Value
`Name`	יה** כ
`ID Number`	*******730

Response

{
  "message": "Record Masked successfully",
  "transactionId": "xxxx-xxxx-xxxx-xxxx"
}

Polisot

Read policy data attached to a transaction — the full list, all policy data, or a single policy by number.

Get Polisot List Of Transaction

Returns the list of policies discovered for a transaction with their headline details.

GET/api/transaction/{transactionId}/polisot/

Key	Req.	Description
`transactionId`	Yes	Transaction ID in URL

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx",
  "status": "finished",
  "action_code": "9100",
  "person_id_number": "123456789",
  "polisot": [
    {
      "manufacturer": "",
      "product_type": "",
      "polisa_number": "xxxxxx",
      "polisa_name": "xxxxxx",
      "polisa_status": "active"
    }
  ]
}

All Polisot Data

Returns the full data object for every policy on the transaction.

GET/api/transaction/{transactionId}/polisot/data

Key	Req.	Description
`transactionId`	Yes	Transaction ID in URL

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx",
  "status": "finished",
  "action_code": "9100",
  "person_id_number": "123456789",
  "polisot": [
    {
      // *** Full Data Of Polisa ***
    }
  ]
}

Get Data Of Specific Polisa

Returns the full data object for a single policy, identified by its number.

GET/api/transaction/{transactionId}/polisot/{polisa_Number}

Key	Req.	Description
`transactionId`	Yes	Transaction ID in URL
`polisa_Number`	Yes	Polisa number in URL

Response

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx",
  "status": "finished",
  "action_code": "9100",
  "person_id_number": "123456789",
  "polisot": [
    {
      // *** Full Data Of Polisa ***
    }
  ]
}

General

Get Manufacturers List

Returns the full list of insurance manufacturers with their manager and handler IDs — used to populate the manufacturer field on transaction requests.

GET/api/manufacturers/list/

Response

{
  "manufacturers": [
    {
      "name": "אי. אי. ג'י ישראל חברה לביטוח בע\"מ",
      "manager_id": 512304882,
      "handler": 513924068
    },
    {
      "name": "מנורה מבטחים פנסיה וגמל בע\"מ (גמל)",
      "manager_id": 512245812,
      "handler": 512790221
    }
  ]
}

Platform

Webhooks

When a transaction is finished or failed, you can receive a callback with files at a specific webhook URL.

A general webhook can be sent for 9100 / 1700 / 9401 / policy_copy requests.

Webhook Payload

{
  "transaction_id": "xxxx-xxxx-xxxx-xxxx",
  "mislaka_number": "xxxx-xxxx-xxxx-xxxx",
  "status": "finished",
  "action_code": "9100",
  "person_id_number": "123456789"
}

Security

Security and your data are important to us. The guidelines below cover data retention, login and API hardening.

Data & Retention

Data is stored for only 7 days. Any files that reach 7 days or older are deleted.
After files are deleted, we mask all PII in our database — such as person ID number and name.
Masking & delete-files methods are available via the API. After fetching files, we strongly recommend sending a request to delete files and mask data.

Login

Login requires 2FA to your mobile phone.
Change your password once every 3–6 months.
A few bad login attempts will block your login.

API

Send your API requests with TLS 1.2 or higher.
HTTPS only — regular HTTP is blocked.
Rate limit — 100 requests / 1 minute.
IP restriction — you can set up an IP whitelist to receive requests.

Automation Platforms

Our goal is to make integration easier. Connect Mislaka-API to the automation platforms you already use.

Platform	Status	Link
`Connectika.io`	✓ Done	connectika.io
`Zapier`	Coming soon	—
`Make`	Coming soon	—

Postman Collection

Using Postman? Contact us and we'll send you a Collection.json file that contains all of our API requests, ready to import.

Request the collection →

Contact

Have questions? We're here to help.

Email

[email protected]

Phone

058-408-4080

Website

nobel.co.il