Loading...
 
Skip to main content

Application API V2

External Partner Documentation


1. Authentication

1.1 Endpoints

1.2 Login

Endpoint: https://api-login-dev.is-il.org.il/connect/token
Request body (form-data):
key: client_id
key: client_secret
Response: access_token

Note: A Bearer token (access_token) must be included in the Authorization header of every request.



2. Retrieving Applications (GET)

2.1 Overview

All GET endpoints share the same query parameters.
DateTime format: 'YYYY-MM-DDTHH:MM:SS:NNN'
Paging: up to 200 applications per response. Each response includes a HasMore field.
• HasMore = true → more data available; send another request.
• HasMore = false → all data returned.
Successful response starts with: "IsSuccessful": true

2.2 Endpoints

  • Retrieve general application data: GET /GeneralData
  • Retrieve applicant documents: GET /ApplicantDocuments
  • Retrieve status log: GET /StatusLog
  • Retrieve contacts: GET /Contacts
  • Retrieve message board: GET /MessageBoard
  • Retrieve active tasks: GET /Tasks
  • Retrieve approver documents: GET /ApproverDocuments
  • Retrieve recipient companies in request: GET /RecipientCompaniesInRequest
  • Retrieve system identifiers: GET /data/?table=table name

2.3 Parameters

Description Field Type Notes / Values
Filter by recipient company ID CompanyId String (guid) Required, unless MotherCompanyId is provided
Filter by parent company ID MotherCompanyId String (guid) Required, unless CompanyId is provided
Polygon field type selector AOIGeoJsonXY Boolean If true, only this field is returned. Default when no parameter is sent.
- AOIGeoJsonLatLong Boolean If true, only this field is returned.
Retrieve a specific application by ID ApplicationId String (guid) <div style="text-align: center;">When provided, only this application is returned, regardless of other parameters.</div>
Retrieve open / closed applications IsOpenStatus Boolean Required. true = open (submitted, completions required). false = closed (pending reopen, end of treatment, cancelled).
Filter by submission date (start) FromSentDate DateTime Use with ToSentDate to define a submission date range.
Filter by submission date (end) ToSentDate DateTime Use with FromSentDate to define a submission date range.
Filter by last modified date (start) FromModifiedOn DateTime Use with ToModifiedOn to define a modification date range.
Filter by last modified date (end) ToModifiedOn DateTime Use with FromModifiedOn to define a modification date range.
Filter by case handler ID OwnerId String (guid)

2.4 Download the full documentation

Image Application API V2 Documentation




3. Updating Applications (POST)

3.1 Required Fields (all endpoints)

Field name Type Description
ApplicationId String (guid) The ID of the application to update.
CompanyId String (guid) The ID of the recipient company.
ModifiedBy-{-"ContactName":-String,-"ContactEmail":-String,-"ContactPhone":-String-} Object Updates the "API Updater Details" field on the application.

3.2 Endpoints

  • General application update: POST /ApplicationData
  • Update to Submitted & In Treatment: POST /SendTreatmentStatus
  • Update to Completions Required: POST /ComplitionsRequiredStatus
  • Update to End of Treatment: POST /EndTreatmentStatus
  • Request to reopen application: POST /ReopenAppRequest

3.3 Endpoint Details

3.3.1 POST /ApplicationData — General Update (no status change)

Field name Type Description
ApplicationId String (guid) The ID of the application to update.
CompanyId String (guid) The ID of the recipient company.
ModifiedBy { "ContactName": String, "ContactEmail": String, "ContactPhone": String } Object Updates the "API Updater Details" field on the application.

3.3.2 POST /SendTreatmentStatus — Update to Submitted & In Treatment

Note: Only allowed when the current application status is 'Completions Required'.

Field name Type Description
SocialMessage String A new message to post on the application message board.

3.3.3 POST /ComplitionsRequiredStatus — Update to Completions Required

Note: Only allowed when the current application status is 'Submitted & In Treatment'.

Field name Type Description
DocumentsForComplition [{ "DocumentId": String (guid) }] Array of objects Required completion documents — up to 3 files.
ComplitionsWithoutDocs String Transition to completions without requesting documents. Attach instructions in the message board.
Attachments [{ "FileName": String, "FileBase64": String (base64) }] Array of objects Uploads files to the Response to Applicant folder under Approver Documents.
SocialMessage String A new message to post on the application message board.
String String Updates the Internal Reference Number / Estimate Number field.
ClassificationId String (guid) Updates the application classification field by classification ID.


Note: Exactly one of the following must be provided: DocumentsForComplition OR ComplitionsWithoutDocs.

3.3.4 POST /EndTreatmentStatus — Update to End of Treatment

Note: This transition is allowed from any status.

Field name Type Description
String (guid) String (guid) Updates the End of Treatment Reason field. Required.
Attachments [{ "FileName": String, "FileBase64": String (base64) }] Array of objects Uploads files to the Approver Documents tab.
SocialMessage String A new message to post on the application message board.
InternalReferenceNumber String Updates the Internal Reference Number / Estimate Number field.
ClassificationId String (guid) Updates the Application Classification field by classification ID.


Note: FinishTreatmentReasonId is required. For citizen-initiated applications, an end-of-treatment file must be attached.

3.3.5 POST /ReopenAppRequest — Approve or Reject Reopen Request

Note: Only allowed when the application status is 'Pending Reopen Approval'.

Field name Type Description
* IsApproved Boolean Approve or reject the reopen request. true = approved (status moves to Submitted & In Treatment). false = rejected (application stays closed).

3.4 Download the full documentation

Image Application API V2 Documentation



4. Error Codes

Error Message Code Description
The 'ApplicationId' provided is invalid. 1055 Invalid application ID — not a string or valid GUID (ApplicationId)
The date format for 'FromAppSentDate' is invalid. Please use 'YYYY-MM-DDTHH:MM:SS:NNN'. 1059 Invalid date or out-of-range date in FromAppSentDate
The 'IsApproved' field is required and cannot be empty. 1039 Required field missing (IsApproved)
Both FileName and FileBase64 fields are required. 1046 Both FileName and FileBase64 are mandatory
The application you are trying to update has been canceled by the applicant. 1007 Application is in Document Collection status
The application has not been submitted yet. 1008 Application is in Cancelled status
The 'OwnerId' provided is invalid. 1066 Invalid handler ID (OwnerId)
The 'ModifiedOn' date cannot be in the future. 1064 Future date in ModifiedOn
Cannot reopen an application in End of Treatment status except via reopen process. 1024 Status transition not allowed
The current application status does not permit this type of update. 1069 Status-based update not permitted
The same 'DocumentId' was provided more than once. 1031 Duplicate DocumentId in DocumentsForComplition
The 'FinishTreatmentReasonId' provided does not exist. 1036 End of treatment reason ID not found
The 'FinishTreatmentReasonId' provided is invalid. 1038 Invalid end of treatment reason ID
The 'Attachments' array is missing. An end-of-treatment file is required for citizen applications. 1040 Missing file attachment for citizen application
The 'FileName' in 'Attachments' is invalid. 1014 Invalid file name — not a string
The 'FileBase64' in 'Attachments' is invalid. Please use base64 format. 1015 File not in valid base64 format
The date format for 'ModifiedOn' is invalid. 1063 Invalid date format in ModifiedOn
The 'ToAppSentDate' cannot be in the future. 1062 Future date in ToAppSentDate
The 'OwnerId' does not exist. 1065 Handler ID not found
The application is already in End of Treatment status. 1034 Cannot update a closed application
Required fields missing in Attachments object (FileName / DocumentId / FileBase64). 1017 Incomplete attachment object
The value for 'OnlyOpenApplications' is invalid. 1057 Invalid value for OnlyOpenApplications
The 'ContactPhone' is invalid. 1022 Invalid phone number (ContactPhone)
The 'ContactEmail' is invalid. 1021 Invalid email address (ContactEmail)
The 'FromAppSentDate' cannot be in the future. 1060 Future date in FromAppSentDate
The uploaded file exceeds the 25 MB limit. 1016 File size over 25 MB
At least one of 'DocumentsForComplition' or 'ComplitionsWithoutDocs' is required. 1026 Missing required completion field
The 'ModifiedBy' object is missing required fields. 1019 Incomplete ModifiedBy object
'CompanyId' is missing from the request. 1043 Required field CompanyId missing
The 'CompanyId' is invalid. 1004 Invalid recipient company ID
Interface operation failed. 1047 General interface error
The 'InternalReferenceNumber' is invalid. 1010 Not a string value
The date format for 'ToAppSentDate' is invalid. 1061 Invalid date format in ToAppSentDate
The 'ApplicationId' is invalid. 1001 Invalid application ID
The 'CompanyId' does not exist. 1006 Recipient company not found
At least one field (besides ModifiedBy) is required. 1023 No payload field provided
The 'Note' in 'DocumentsForComplition' is invalid. 1032 Invalid note field
'FinishTreatmentReasonId' is required and cannot be empty. 1035 Required field missing
Invalid value for AOICentroidXY / AOICentroidLatLong. 1067 Must be true or false
No reopening request was submitted by the applicant. 1041 Cannot reopen — no reopen request found
The 'DocumentId' in 'DocumentsForComplition' is not active. 1029 Document is inactive or cancelled
The 'MotherCompanyId' is invalid. 1052 Invalid parent company ID
The 'DocumentId' in 'DocumentsForComplition' is invalid. 1030 Invalid document ID
The 'CompanyId' does not match your associated company. 1005 Company ID does not belong to API user
The 'FinishTreatmentReasonId' does not match the request type. 1037 Reason does not match application type
The 'ClassificationId' does not exist. 1011 Classification ID not found
The 'IsApproved' value is invalid. 1042 Must be true or false
The 'MotherCompanyId' does not exist. 1053 Parent company not found
Cannot update status to 'Submitted & In Treatment' unless current status is 'Completions Required'. 1044 Invalid status transition
The 'ClassificationId' does not match your associated company. 1012 Classification belongs to a different company
Both 'MotherCompanyId' and 'CompanyId' are missing. 1050 At least one company ID is required
The 'SocialMessage' is invalid. 1009 Not a string value
The application does not belong to your company (pull). 1056 Access denied to this application
The 'DocumentId' in 'DocumentsForComplition' does not exist. 1028 Document ID not found
The 'ModifiedBy' object is required. 1018 Required field missing
The 'ComplitionsWithoutDocs' value is invalid. 1033 Empty or not a valid string
Only one of 'DocumentsForComplition' or 'ComplitionsWithoutDocs' should be provided. 1027 Multiple completion fields provided
The 'MotherCompanyId' does not match your associated company. 1054 Parent company ID does not belong to API user
A completion file must be submitted for the initiating company. 1049 End of treatment file required
Access denied to this table. 1068 Insufficient permissions
The 'ApplicationId' does not exist. 1002 Application not found
The 'CompanyId' does not match your associated company (update). 1051 Company ID does not belong to API user
The 'InternalReferenceNumber' exceeds the character limit. 1045 Value too long
'FromAppSentDate' cannot be after 'ToAppSentDate'. 1058 Start date is after end date
You can upload up to 3 documents during the completion process. 1048 Document limit exceeded
The 'ClassificationId' is invalid. 1013 Invalid classification ID
The application does not belong to your company (update). 1003 Access denied to this application
The 'ContactName' is invalid. 1020 Not a string (ContactName)
'ApplicationId' is missing from the request. 1000 Required field missing



5. Download the full documentation


Image Application API V2 Documentation