{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d7730c17-c583-43b0-a49e-e75626729c32","name":"Workhy - Incorporation API","description":"This documentation is prepared for developers who wish to use Workhy Incorporation API.\n\nOur API supports functionalities such as incorporation and offers partners of Workhy a rich set of features for their applications.\n\nThis documentation provides step-by-step guides, examples, and best practices for using our API. Our goal is to make our API as easy and accessible as possible, enabling you to quickly and effectively create value in your own projects.\n\n# Get Started\n\nFirst, you need to create an account on our [dev@workhy.com ](https://dev@workhy.com) After creating an account, you will receive an API key and a secret key. You will use these keys to authenticate your requests to our API.\n\n# Erros\n\nOur API uses standard HTTP status codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with our servers.\n\n# Expanding Responses\n\nIncluding Related Objects; Some API endpoints allow you to expand the response to include related objects. For example, when retrieving a company, you can expand the response to  \ninclude the company's users, subscription, and other related objects.\n\n# Sandbox\n\nWe provide a Sandbox testing environment for developers, allowing you to safely test our API without working with real-world data. Our Sandbox environment features full API capabilities but operates on demo data.\n\n**Sandbox Environment URL**: `https://api-beta.mukellef.co/`\n\nUsing this environment, you can test your application's integration with our API risk-free.\n\n# Rate Limit\n\nTo maintain the performance of our API and ensure fair usage, we apply rate limiting. Limits are based on the number of requests made per minute by each user.\n\n- **Standard Rate Limit**: 100 requests per minute.\n    \n\nExceeding these limits will result in a 429 Too Many Requests error. In such cases, you will need to slow down your request rate.\n\n# Webhooks\n\nYour application can subscribe to various events in our API using webhooks. When an event occurs, we will send an HTTP POST request to the URL you specify. This allows your application to receive real-time updates about changes to data in our system.\n\n# Changelog\n\n### v1.2.1 - 2024-03-01\n\n- Uk Company Creation changed. Now, you can create a UK company in 2 steps.\n    \n- Added detail folder & endpoints documentation.\n    \n- Uk Company Creation folder structure changed.\n    \n\n### v.1.2 - 2024-02-23\n\n- OAuth 2.0 \"Client Credentials Flow\" implemented.\n    \n- Webhooks usage added to related endpoints.\n    \n- Some endpoints requests and responses changed for Client Credentials Flow\n    \n\n### v1.1.6 - 2023-11-07\n\n- Authorization test added.\n    \n\n### v1.1.5 - 2023-10-12\n\n- Bank Transfer endpoints.\n    \n- Mobile Device added.\n    \n- Policies endpoint added.\n    \n- **Get Calendar Events** endpoint gets events from Google Calendar\n    \n- Terms of Service is updated. User has to accept before use our services. Self > ToS and Self > ToS Accept endpoints added.\n    \n- Optional `mobile` field added to `register`endpoint. We will send SMS verification code to customer directly if filled mobile in the request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18907995","collectionId":"d7730c17-c583-43b0-a49e-e75626729c32","publishedId":"2s9YXfc42u","public":true,"publicUrl":"https://docs.mukellef.co","privateUrl":"https://go.postman.co/documentation/18907995-d7730c17-c583-43b0-a49e-e75626729c32","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/582cfc2d-1926-428f-8159-8b04e3dd119e/bG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/582cfc2d-1926-428f-8159-8b04e3dd119e/bG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-11-07T10:26:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/582cfc2d-1926-428f-8159-8b04e3dd119e/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/582cfc2d-1926-428f-8159-8b04e3dd119e/bG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"Mukellef - Open","id":"167c3ccc-cbe2-47e6-a8e6-dfd19c422421","owner":"18907995","values":[{"key":"api_base_endpoint","value":"https://api-beta.mukellef.co/","enabled":true},{"key":"url","value":"https://api-beta.mukellef.co/","enabled":true,"type":"default"},{"key":"client_id","value":"18","enabled":true},{"key":"client_secret","value":"VbHGn1W6OyVR2hbveALghwPqj5yOJHHDmCldAO8n","enabled":true},{"key":"content_type","value":"application/x-www-form-urlencoded","enabled":true},{"key":"access_token","value":"","enabled":true},{"key":"refresh_token","value":"","enabled":true},{"key":"company_id","value":"5075","enabled":true},{"key":"username","value":"","enabled":true},{"key":"lang","value":"tr","enabled":true},{"key":"channel_id","value":"","enabled":true},{"key":"user_id","value":"8","enabled":true,"type":"default"},{"key":"open_api_acces_token","value":"","enabled":true,"type":"any"},{"key":"admin_access_token","value":"","enabled":true,"type":"any"},{"key":"file_id","value":"null","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://mukellef.co/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Mukellef - Open","value":"18907995-167c3ccc-cbe2-47e6-a8e6-dfd19c422421"}],"canonicalUrl":"https://docs.mukellef.co/view/metadata/2s9YXfc42u"}