{ "info": { "_postman_id": "b3d986e2-90d8-4e5b-a6e2-7b6cb732a20b", "name": "Remote Address Details Testing & Sandbox API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:47:56.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "lastUpdatedBy": "35240", "uid": "35240-b3d986e2-90d8-4e5b-a6e2-7b6cb732a20b" }, "item": [ { "name": "v1", "item": [ { "name": "sdk", "item": [ { "name": "telemetry-errors", "item": [ { "name": "Report SDK errors", "id": "97841164-eecf-4f76-9abd-e5ef65e1ed6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"error\": {\n \"message\": \"\",\n \"name\": \"\",\n \"category\": \"RENDER_ERROR\",\n \"severity\": \"error\",\n \"component_stack\": [\n \"\",\n \"\"\n ],\n \"stack\": \"\"\n },\n \"metadata\": {\n \"sdk_version\": \"97.64327335.689\",\n \"timestamp\": \"\",\n \"url\": \"\",\n \"user_agent\": \"\",\n \"environment\": \"local\"\n },\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sdk/telemetry-errors", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sdk", "telemetry-errors" ] }, "description": "Receives error telemetry from the frontend SDK.\nErrors are logged to observability backend for monitoring and debugging.\n" }, "response": [ { "id": "fe1b2a6e-368e-466f-a1e2-6bbfff660271", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"error\": {\n \"message\": \"\",\n \"name\": \"\",\n \"category\": \"RENDER_ERROR\",\n \"severity\": \"error\",\n \"component_stack\": [\n \"\",\n \"\"\n ],\n \"stack\": \"\"\n },\n \"metadata\": {\n \"sdk_version\": \"97.64327335.689\",\n \"timestamp\": \"\",\n \"url\": \"\",\n \"user_agent\": \"\",\n \"environment\": \"local\"\n },\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sdk/telemetry-errors", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sdk", "telemetry-errors" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-fe1b2a6e-368e-466f-a1e2-6bbfff660271" }, { "id": "b8afe62e-16ef-47c4-af5e-751a326bca25", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"error\": {\n \"message\": \"\",\n \"name\": \"\",\n \"category\": \"RENDER_ERROR\",\n \"severity\": \"error\",\n \"component_stack\": [\n \"\",\n \"\"\n ],\n \"stack\": \"\"\n },\n \"metadata\": {\n \"sdk_version\": \"97.64327335.689\",\n \"timestamp\": \"\",\n \"url\": \"\",\n \"user_agent\": \"\",\n \"environment\": \"local\"\n },\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sdk/telemetry-errors", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sdk", "telemetry-errors" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"details\": \"\",\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-b8afe62e-16ef-47c4-af5e-751a326bca25" }, { "id": "cf7ed5be-ea07-44e1-9fc3-e80a119f3aa0", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"error\": {\n \"message\": \"\",\n \"name\": \"\",\n \"category\": \"RENDER_ERROR\",\n \"severity\": \"error\",\n \"component_stack\": [\n \"\",\n \"\"\n ],\n \"stack\": \"\"\n },\n \"metadata\": {\n \"sdk_version\": \"97.64327335.689\",\n \"timestamp\": \"\",\n \"url\": \"\",\n \"user_agent\": \"\",\n \"environment\": \"local\"\n },\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sdk/telemetry-errors", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sdk", "telemetry-errors" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-cf7ed5be-ea07-44e1-9fc3-e80a119f3aa0" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-97841164-eecf-4f76-9abd-e5ef65e1ed6f" } ], "id": "70e46b4a-88d7-4fec-b76f-54b5afeb59ba", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-70e46b4a-88d7-4fec-b76f-54b5afeb59ba" } ], "id": "a2f6749c-b8ac-4054-a29e-f1b76d6bd1f8", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-a2f6749c-b8ac-4054-a29e-f1b76d6bd1f8" }, { "name": "sandbox", "item": [ { "name": "companies", "item": [ { "name": "{company_id}", "item": [ { "name": "bypass-eligibility-checks", "item": [ { "name": "Pass KYB", "id": "78e35fb4-8ce4-49a8-ba3a-88eb9ac2045e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "id": "6ef2c9ff-48cd-4e5a-a5ed-ca1d134c3684", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Pass KYB and credit risk for a company without the intervention of a Remote admin.\n\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "7d365047-5688-4842-9227-10691fdd788e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-7d365047-5688-4842-9227-10691fdd788e" }, { "id": "6b2cca7e-b83b-4064-b3de-4aac7703bd96", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "key": "company_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-6b2cca7e-b83b-4064-b3de-4aac7703bd96" }, { "id": "7aa6f168-5f84-48e2-b59d-85884ce65ffb", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-7aa6f168-5f84-48e2-b59d-85884ce65ffb" }, { "id": "03a99b15-824a-4265-a56d-e809dc409bcf", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-03a99b15-824a-4265-a56d-e809dc409bcf" }, { "id": "23d1308b-0176-46d2-8cb9-6a546163278f", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-23d1308b-0176-46d2-8cb9-6a546163278f" }, { "id": "76527c83-9ef6-49e1-812a-007960721f88", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/bypass-eligibility-checks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "bypass-eligibility-checks" ], "variable": [ { "key": "company_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-76527c83-9ef6-49e1-812a-007960721f88" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-78e35fb4-8ce4-49a8-ba3a-88eb9ac2045e" } ], "id": "ab416c0b-6cf5-437d-8185-9341fa6982c0", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ab416c0b-6cf5-437d-8185-9341fa6982c0" }, { "name": "legal-entities", "item": [ { "name": "{legal_entity_id}", "item": [ { "name": "activate-global-payroll", "item": [ { "name": "Activate Global Payroll for a legal entity", "id": "87d695f1-3685-4027-9197-70bd9e8dd88d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "id": "301895ee-139c-4abb-b782-9daf1873f23e", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "b43f0d9c-f666-4373-89bf-7919687b6e78", "key": "legal_entity_id", "value": "", "description": "(Required) Legal Entity ID to activate Global Payroll on" } ] }, "description": "Enables the Global Payroll product on a legal entity so that GP employees can be created against it.\n\nPerforms three idempotent steps:\n * Adds the Global Payroll product to the company.\n * Flips `global_payroll_enabled` on the legal entity's settings.\n * Ensures a Global Payroll pricing plan exists for the legal entity's country.\n\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "ca05c4da-5c27-45ad-a010-2da977753898", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ca05c4da-5c27-45ad-a010-2da977753898" }, { "id": "da964b2f-b3e5-4c7e-9488-f69be9b7f300", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-da964b2f-b3e5-4c7e-9488-f69be9b7f300" }, { "id": "b8996aa1-2482-400b-b03f-b6e8614ad3ee", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-b8996aa1-2482-400b-b03f-b6e8614ad3ee" }, { "id": "e74e7a42-7572-4c39-a7d3-340d9dea45ca", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-e74e7a42-7572-4c39-a7d3-340d9dea45ca" }, { "id": "0f9421aa-9870-47ec-acbb-3c9ebff92d93", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-0f9421aa-9870-47ec-acbb-3c9ebff92d93" }, { "id": "f271bbad-89a3-4388-af77-bf16bc733ca0", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/activate-global-payroll", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "activate-global-payroll" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-f271bbad-89a3-4388-af77-bf16bc733ca0" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-87d695f1-3685-4027-9197-70bd9e8dd88d" } ], "id": "ea4cb1cf-dc22-46c5-93e5-cef3ba422e21", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ea4cb1cf-dc22-46c5-93e5-cef3ba422e21" }, { "name": "set-credit-risk-status", "item": [ { "name": "Set company credit risk status", "id": "8ddef364-03c1-4632-8fbb-99c19f8d7cd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "id": "6f28a34d-a147-408a-995c-9c500e02d2f9", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "2d17a075-e951-45e3-8897-6263df6e3d43", "key": "legal_entity_id", "value": "", "description": "(Required) Legal Entity ID" } ] }, "description": "Sets the credit risk status of a specific legal entity to any valid credit risk status.\n\nUse this endpoint to test hiring flows affected by credit risk, without needing Remote admin intervention.\n\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "782ea019-d8ed-478b-9868-c9216228720e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-782ea019-d8ed-478b-9868-c9216228720e" }, { "id": "fb12e95a-358f-4b31-8bcd-5cf3637cb673", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-fb12e95a-358f-4b31-8bcd-5cf3637cb673" }, { "id": "3be1ecb0-de37-478e-93e0-192a806c66ae", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-3be1ecb0-de37-478e-93e0-192a806c66ae" }, { "id": "ea6be849-fb35-4510-b71e-dab4f87b758f", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ea6be849-fb35-4510-b71e-dab4f87b758f" }, { "id": "68281566-cd3f-46ab-ade6-64404fc430a8", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-68281566-cd3f-46ab-ade6-64404fc430a8" }, { "id": "6b4f2408-e14e-419b-b9dd-3b59539ddae4", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"credit_risk_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities/:legal_entity_id/set-credit-risk-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities", ":legal_entity_id", "set-credit-risk-status" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-6b4f2408-e14e-419b-b9dd-3b59539ddae4" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-8ddef364-03c1-4632-8fbb-99c19f8d7cd7" } ], "id": "94843c72-172c-43df-8d62-e120dc3dd587", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-94843c72-172c-43df-8d62-e120dc3dd587" } ], "id": "42d635aa-87ad-4b88-b8e1-985a5f23fb71", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-42d635aa-87ad-4b88-b8e1-985a5f23fb71" }, { "name": "Create a legal entity", "id": "71c26c12-24c7-433c-994c-1b6aa06edfab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "id": "b54c9e02-ff19-44a7-b82d-51c35ff4eff1", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Create a new legal entity for a company in a given country, with KYB automatically passed.\n\nThe entity is created with active status and can be set as the company's default\nusing the reassign default entity endpoint.\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "509f24e3-7bcd-4c23-94ea-d8e1cf8da8b7", "name": "Legal entity created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "key": "company_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"legal_entity_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-509f24e3-7bcd-4c23-94ea-d8e1cf8da8b7" }, { "id": "5479a9bb-9226-4d42-a248-2ac082b1a4b2", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "key": "company_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-5479a9bb-9226-4d42-a248-2ac082b1a4b2" }, { "id": "e770124b-aa0c-4b6e-be3b-9ce39d9a7565", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-e770124b-aa0c-4b6e-be3b-9ce39d9a7565" }, { "id": "efa134b7-80bd-4051-be22-f6941f7afbc0", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-efa134b7-80bd-4051-be22-f6941f7afbc0" }, { "id": "ad9aac20-77ed-4fc8-8dd9-bf31141f7383", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ad9aac20-77ed-4fc8-8dd9-bf31141f7383" }, { "id": "e31a4ffb-4367-4617-be1f-02fd022e77ce", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"country_code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/legal-entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "legal-entities" ], "variable": [ { "key": "company_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-e31a4ffb-4367-4617-be1f-02fd022e77ce" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-71c26c12-24c7-433c-994c-1b6aa06edfab" } ], "id": "ac9b7319-d9ca-4476-81f1-83c00db6db38", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ac9b7319-d9ca-4476-81f1-83c00db6db38" }, { "name": "default-legal-entity", "item": [ { "name": "{legal_entity_id}", "item": [ { "name": "Reassign default legal entity", "id": "851e3c46-00e5-4156-b873-28ee80ed0863", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "id": "4bb0e8ef-1f7f-4172-b677-d411b0a376aa", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "7fe6c8bf-5a46-4110-8a2a-8c8dc6210a9b", "key": "legal_entity_id", "value": "", "description": "(Required) Legal Entity ID to set as the new default" } ] }, "description": "Set a different legal entity as the company's default entity.\n\nThe default entity is used when creating new employments without an explicit entity.\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "ddfe710e-c789-4090-824b-95d3c3e55d54", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ddfe710e-c789-4090-824b-95d3c3e55d54" }, { "id": "651cfad2-1b47-470c-a2f5-3443094aa14e", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-651cfad2-1b47-470c-a2f5-3443094aa14e" }, { "id": "b44b7593-e9cc-4430-a5d8-35f504d2e126", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-b44b7593-e9cc-4430-a5d8-35f504d2e126" }, { "id": "6b83028d-ec1a-48cd-865e-64bc8c932bf1", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-6b83028d-ec1a-48cd-865e-64bc8c932bf1" }, { "id": "728a8449-56ea-4da5-9107-7f78bbcc6f47", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-728a8449-56ea-4da5-9107-7f78bbcc6f47" }, { "id": "d1b84245-1c20-448f-989c-21a678d032a0", "name": "Too many requests", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/companies/:company_id/default-legal-entity/:legal_entity_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "companies", ":company_id", "default-legal-entity", ":legal_entity_id" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-d1b84245-1c20-448f-989c-21a678d032a0" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-851e3c46-00e5-4156-b873-28ee80ed0863" } ], "id": "52567ab3-9728-45d9-90eb-024d7e6f3d67", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-52567ab3-9728-45d9-90eb-024d7e6f3d67" } ], "id": "04026f33-0457-4fd3-abc8-2f1a04782bbf", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-04026f33-0457-4fd3-abc8-2f1a04782bbf" } ], "id": "8cf2e0ba-2086-4224-a113-2ab39f6fd9de", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-8cf2e0ba-2086-4224-a113-2ab39f6fd9de" } ], "id": "0e1aeada-cdab-494f-94e9-bfc8bd645fab", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-0e1aeada-cdab-494f-94e9-bfc8bd645fab" }, { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "risk-reserve-proof-of-payments", "item": [ { "name": "approve", "item": [ { "name": "Approve risk reserve proof of payment", "id": "7d630488-7ebf-4a91-ae97-43cb41afd39d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "id": "4c512871-3742-4f27-a65a-058975c060ab", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Approves a risk reserve proof of payment without the intervention of a Remote admin.\n\nTriggers an `employment.cor_hiring.proof_of_payment_accepted` webhook event.\n\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "30764aaa-cb0f-45d8-b765-a2a5d5356bca", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"slug\": \"\",\n \"status\": \"rejected\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-30764aaa-cb0f-45d8-b765-a2a5d5356bca" }, { "id": "2849eb90-0428-45b0-a29e-69986b7cd793", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-2849eb90-0428-45b0-a29e-69986b7cd793" }, { "id": "9a487bd8-501d-49ef-ad96-906d36fb807d", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-9a487bd8-501d-49ef-ad96-906d36fb807d" }, { "id": "40aa994c-8f35-451a-9ecf-65730bb2b3f5", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-40aa994c-8f35-451a-9ecf-65730bb2b3f5" }, { "id": "36aae90a-3373-4ad6-9064-2fd6a15807c2", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-36aae90a-3373-4ad6-9064-2fd6a15807c2" }, { "id": "8db5cdd6-fcea-4e1e-997f-fd5b4f182f55", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id/risk-reserve-proof-of-payments/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id", "risk-reserve-proof-of-payments", "approve" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-8db5cdd6-fcea-4e1e-997f-fd5b4f182f55" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-7d630488-7ebf-4a91-ae97-43cb41afd39d" } ], "id": "65454672-c4a5-463a-aac2-10a4880cd953", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-65454672-c4a5-463a-aac2-10a4880cd953" } ], "id": "a86ab3d4-66b6-4c23-b0aa-64a28126d1fb", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-a86ab3d4-66b6-4c23-b0aa-64a28126d1fb" }, { "name": "Archive employment", "id": "eb005ad7-4bfe-4714-8f05-c3c9234e57d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "id": "80433058-28f8-49c6-81e4-8c558fc89dff", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Archives an employment, setting its status to `archived`.\n\nThis endpoint is only available in Sandbox and allows partners to clean up test\nemployees during automated E2E testing without requiring Remote manual intervention.\n\nThis endpoint will respond with a 404 outside of the Sandbox environment.\n" }, "response": [ { "id": "bd53c5d5-038d-42a0-9f9c-c35a50855202", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-bd53c5d5-038d-42a0-9f9c-c35a50855202" }, { "id": "0d033db3-86ff-4c3b-9b52-fc65e4d06e2a", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-0d033db3-86ff-4c3b-9b52-fc65e4d06e2a" }, { "id": "dd61823b-4e33-47dc-80f7-07b97618e9fe", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-dd61823b-4e33-47dc-80f7-07b97618e9fe" }, { "id": "615101d9-c533-4e4d-919d-c716ac9a4747", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-615101d9-c533-4e4d-919d-c716ac9a4747" }, { "id": "78d0de94-3bad-4721-8a8a-85c6908f70ac", "name": "Unprocessable Entity", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-78d0de94-3bad-4721-8a8a-85c6908f70ac" }, { "id": "4a3ffc6a-3938-4fa2-8f36-1ea14f8f8703", "name": "Too many requests", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-4a3ffc6a-3938-4fa2-8f36-1ea14f8f8703" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-eb005ad7-4bfe-4714-8f05-c3c9234e57d6" }, { "name": "Update employment", "id": "71009ac1-13bb-4459-9abb-f3ac5205c6fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "id": "49d0e783-baa2-41c5-96c8-b37940c664ff", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates an employment. Use this endpoint to:\n- modify employment states for testing\n- Backdate employment start dates\n\nThis endpoint will respond with a 404 outside of the Sandbox environment.\n\nFor updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment).\n" }, "response": [ { "id": "d5baca8e-649e-4012-9cc7-601b10c401cb", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"direct_employee\",\n \"employment_model\": \"global_payroll\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"annually\"\n },\n \"status\": \"review\",\n \"employment_lifecycle_stage\": \"employment_creation\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"weekly\",\n \"slug\": \"\",\n \"type\": \"hourly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"deleted\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-d5baca8e-649e-4012-9cc7-601b10c401cb" }, { "id": "49f1e99e-96eb-4862-a334-2b60dce38b3f", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-49f1e99e-96eb-4862-a334-2b60dce38b3f" }, { "id": "648d5979-b597-45cf-9dd0-d976550e1e4e", "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-648d5979-b597-45cf-9dd0-d976550e1e4e" }, { "id": "6b764487-1d5e-4b7c-ae1c-8df11e9ccfd8", "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-6b764487-1d5e-4b7c-ae1c-8df11e9ccfd8" }, { "id": "f6f2962c-1fce-481d-acb0-de23760fcb06", "name": "Conflict", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-f6f2962c-1fce-481d-acb0-de23760fcb06" }, { "id": "feca0016-c6fe-4b4a-95c1-a2400076177f", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-feca0016-c6fe-4b4a-95c1-a2400076177f" }, { "id": "565cc6a0-e0fd-4b4f-9a26-15134d6f37fc", "name": "Too many requests", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-565cc6a0-e0fd-4b4f-9a26-15134d6f37fc" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-71009ac1-13bb-4459-9abb-f3ac5205c6fb" }, { "name": "Update employment", "id": "a1cf96c7-304c-43e4-8c82-480ad410a5ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "id": "73a3a560-8f26-418b-9039-c49c6812daba", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates an employment. Use this endpoint to:\n- modify employment states for testing\n- Backdate employment start dates\n\nThis endpoint will respond with a 404 outside of the Sandbox environment.\n\nFor updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment).\n" }, "response": [ { "id": "65ba8dac-4529-4adb-b186-633d32350dea", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"direct_employee\",\n \"employment_model\": \"global_payroll\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"annually\"\n },\n \"status\": \"review\",\n \"employment_lifecycle_stage\": \"employment_creation\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"weekly\",\n \"slug\": \"\",\n \"type\": \"hourly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"deleted\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-65ba8dac-4529-4adb-b186-633d32350dea" }, { "id": "a8a15d46-ef9f-4aa8-afab-8d8b0f4b09cf", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-a8a15d46-ef9f-4aa8-afab-8d8b0f4b09cf" }, { "id": "37b0b2a3-3e61-45be-bbee-8cb0b8d6af43", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-37b0b2a3-3e61-45be-bbee-8cb0b8d6af43" }, { "id": "99fcc84e-7520-4108-b7e5-ed922e883c70", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-99fcc84e-7520-4108-b7e5-ed922e883c70" }, { "id": "b8709e4f-9fff-4368-8972-c6bc0013c543", "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-b8709e4f-9fff-4368-8972-c6bc0013c543" }, { "id": "b3aee89f-4d7f-415e-99bc-a0eeae39a373", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-b3aee89f-4d7f-415e-99bc-a0eeae39a373" }, { "id": "0c7e678f-3dbc-4ed6-8c20-6eb3092bd926", "name": "Too many requests", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"provisional_start_date\": \"\",\n \"status\": \"initiated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-0c7e678f-3dbc-4ed6-8c20-6eb3092bd926" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-a1cf96c7-304c-43e4-8c82-480ad410a5ff" } ], "id": "ac17c510-5b8d-4436-b32f-00ab11290e86", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-ac17c510-5b8d-4436-b32f-00ab11290e86" }, { "name": "Create employment", "id": "211faa8c-3d09-4244-9d1a-fd016d100b0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] }, "description": "Creates an employment without provisional_start_date validation.\n\nThis endpoint is only available in Sandbox and allows creating employments which\n`provisional_start_date` is in the past. This is especially helpful for:\n * Testing the Timeoff Balance endpoints\n * Testing the Offboarding endpoints\n * Testing features around probation periods\n\nThis endpoint will respond with a 404 outside of the Sandbox environment.\n\nFor creating an employment's parameters outside of testing purposes, use [this\nEmployment create endpoint](#operation/post_create_employment)\n" }, "response": [ { "id": "4358ef10-1eec-42f2-a71e-213fbe774088", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"basic_information\": {},\n \"company_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"employment_lifecycle_stage\": \"offboarded\",\n \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"login_email\": \"\",\n \"personal_email\": \"\",\n \"provisional_start_date\": \"\",\n \"type\": \"employee\",\n \"updated_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-4358ef10-1eec-42f2-a71e-213fbe774088" }, { "id": "e882f9c7-1faa-43c3-abad-482d203d1e3a", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-e882f9c7-1faa-43c3-abad-482d203d1e3a" }, { "id": "814edc9a-8a1e-4558-bb1b-4da7e0afd00f", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-814edc9a-8a1e-4558-bb1b-4da7e0afd00f" }, { "id": "bddd6d87-2b23-4a78-a1ee-ac270c465a51", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-bddd6d87-2b23-4a78-a1ee-ac270c465a51" }, { "id": "c8512e7e-941a-4652-90dc-257345b3362e", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-c8512e7e-941a-4652-90dc-257345b3362e" }, { "id": "190cc030-cdfa-4316-9cc8-ead7edeb4afa", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"hris\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/employments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "employments" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-190cc030-cdfa-4316-9cc8-ead7edeb4afa" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-211faa8c-3d09-4244-9d1a-fd016d100b0d" } ], "id": "86958d7d-9bc5-47db-960c-2fa363188154", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-86958d7d-9bc5-47db-960c-2fa363188154" }, { "name": "benefit-renewal-requests", "item": [ { "name": "Creates a Benefit Renewal Request", "id": "a9d289e5-ed6f-4781-a4c5-4daa11621e09", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"benefit_group_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/benefit-renewal-requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "benefit-renewal-requests" ] }, "description": "Creates a Benefit Renewal Request for a specific Benefit Group.\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "21b0bdd1-4b49-4c1c-b53b-0736cc48f812", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"benefit_group_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/benefit-renewal-requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "benefit-renewal-requests" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"benefit_renewal_request\": {\n \"id\": \"\",\n \"coverage_start_date\": \"\",\n \"coverage_end_date\": \"\",\n \"renewal_selection_start_date\": \"\",\n \"renewal_selection_end_date\": \"\",\n \"renewal_selection_instructions\": \"\",\n \"benefit_group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"country_code\": \"\"\n },\n \"benefit_renewal_response\": {\n \"benefit_tier\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"display_cost\": \"\"\n },\n \"updated_at\": \"\"\n },\n \"number_of_affected_employees\": \"\",\n \"current_benefit_tier\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"display_cost\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-21b0bdd1-4b49-4c1c-b53b-0736cc48f812" }, { "id": "49b9d21b-b853-4bb6-9b57-a17a0cb5ba61", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"benefit_group_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/benefit-renewal-requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "benefit-renewal-requests" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-49b9d21b-b853-4bb6-9b57-a17a0cb5ba61" }, { "id": "6416ed69-71c6-43e2-b2ba-56343b9a7535", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"benefit_group_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/benefit-renewal-requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "benefit-renewal-requests" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-6416ed69-71c6-43e2-b2ba-56343b9a7535" }, { "id": "175ecfbf-e0b3-4112-b50f-392d52112767", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"benefit_group_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/benefit-renewal-requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "benefit-renewal-requests" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-175ecfbf-e0b3-4112-b50f-392d52112767" }, { "id": "5aa46140-fb0a-4934-8bfa-d539cf357d68", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"benefit_group_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/benefit-renewal-requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "benefit-renewal-requests" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-5aa46140-fb0a-4934-8bfa-d539cf357d68" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-a9d289e5-ed6f-4781-a4c5-4daa11621e09" } ], "id": "061f6c98-78b6-4914-8dfd-09e51250b60b", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-061f6c98-78b6-4914-8dfd-09e51250b60b" }, { "name": "contract-amendments", "item": [ { "name": "{contract_amendment_request_id}", "item": [ { "name": "approve", "item": [ { "name": "Approve Contract Amendment", "id": "aebdc266-7b12-49d9-acf7-b0748822ae6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "id": "c4c20e26-a008-4e31-9794-f2c8e4f15a83", "key": "contract_amendment_request_id", "value": "", "description": "(Required) Contract amendment request ID" } ] }, "description": "Approves a contract amendment request without the intervention of a Remote admin.\nApprovals done via this endpoint are effective immediately,\nregardless of the effective date entered on the contract amendment creation.\n\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "63114f88-47a5-4afa-882c-e5c8dd99920b", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"contract_amendment\": {\n \"id\": \"\",\n \"amendment_contract_id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"deleted\",\n \"requested_by\": \"\",\n \"submitted_at\": \"\",\n \"request_details\": {\n \"additional_comments\": \"\",\n \"effective_date\": \"\",\n \"reason_for_change\": \"other\",\n \"reason_for_change_description\": \"\",\n \"salary_decrease_details\": {\n \"salary_decrease_reason\": \"error_in_initial_salary\",\n \"salary_decrease_reason_description\": \"\",\n \"was_employee_informed\": \"\"\n }\n },\n \"changes\": {},\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-63114f88-47a5-4afa-882c-e5c8dd99920b" }, { "id": "70538ed6-f88b-4fcc-880f-a90bf4281919", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-70538ed6-f88b-4fcc-880f-a90bf4281919" }, { "id": "fa3c47b5-5906-451d-8c19-f45e38f2101c", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-fa3c47b5-5906-451d-8c19-f45e38f2101c" }, { "id": "99d89a1f-c39a-4f38-adab-152f61e47983", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-99d89a1f-c39a-4f38-adab-152f61e47983" }, { "id": "242b49d4-9aa7-439e-8b2f-b8a41e3c4c1e", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-242b49d4-9aa7-439e-8b2f-b8a41e3c4c1e" }, { "id": "d1e965b0-1cf2-48ae-9f3c-8f71ce4e8027", "name": "Too many requests", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "approve" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-d1e965b0-1cf2-48ae-9f3c-8f71ce4e8027" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-aebdc266-7b12-49d9-acf7-b0748822ae6c" } ], "id": "a39f1bdf-544c-48d7-989e-2869de07953a", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-a39f1bdf-544c-48d7-989e-2869de07953a" }, { "name": "cancel", "item": [ { "name": "Cancel Contract Amendment", "id": "c6c58d46-0750-4511-bee6-bcd2c4224522", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "id": "73a1aa62-0b73-4fbb-88fd-6a0be3b1373d", "key": "contract_amendment_request_id", "value": "", "description": "(Required) Contract amendment request ID" } ] }, "description": "Use this endpoint to cancel an existing contract amendment request.\n\nThis endpoint is only available in Sandbox, otherwise it will respond with a 404.\n" }, "response": [ { "id": "f2d62e9a-f327-4d6b-a509-61b9f852f03b", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-f2d62e9a-f327-4d6b-a509-61b9f852f03b" }, { "id": "1c5db2b3-0c1f-4e6d-8884-16504891dbbe", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-1c5db2b3-0c1f-4e6d-8884-16504891dbbe" }, { "id": "dd2bb775-0883-4451-8775-a6caa4dc35d7", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-dd2bb775-0883-4451-8775-a6caa4dc35d7" }, { "id": "c6b8ef4f-40ed-45f8-bcdb-32939ef858e9", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-c6b8ef4f-40ed-45f8-bcdb-32939ef858e9" }, { "id": "6d35f4d2-c939-435d-9564-2c913d63aed3", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-6d35f4d2-c939-435d-9564-2c913d63aed3" }, { "id": "953bb9c7-ec41-4006-a670-450533b5d70d", "name": "Too many requests", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/contract-amendments/:contract_amendment_request_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "contract-amendments", ":contract_amendment_request_id", "cancel" ], "variable": [ { "key": "contract_amendment_request_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-953bb9c7-ec41-4006-a670-450533b5d70d" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-c6c58d46-0750-4511-bee6-bcd2c4224522" } ], "id": "92d03bae-47d7-4ad9-aba7-2e06c8c95df7", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-92d03bae-47d7-4ad9-aba7-2e06c8c95df7" } ], "id": "cbab4acf-ee68-41e9-bc41-aa73eaf84230", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-cbab4acf-ee68-41e9-bc41-aa73eaf84230" } ], "id": "58f04d3c-6364-4cae-9f04-621d521ecb8e", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-58f04d3c-6364-4cae-9f04-621d521ecb8e" }, { "name": "webhook-callbacks", "item": [ { "name": "trigger", "item": [ { "name": "Trigger a Webhook", "id": "12822cf9-799d-4196-8a54-0ebca9c752d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"event_type\": \"contract_amendment.submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/webhook-callbacks/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "webhook-callbacks", "trigger" ] }, "description": "Triggers a callback previously registered for webhooks. Use this endpoint to\nemit a webhook for testing in the Sandbox environment. This endpoint will\nrespond with a 404 outside of the Sandbox environment.\n" }, "response": [ { "id": "733b2510-e0a2-400e-aff0-57896d96b8ce", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"event_type\": \"contract_amendment.submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/webhook-callbacks/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "webhook-callbacks", "trigger" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-733b2510-e0a2-400e-aff0-57896d96b8ce" }, { "id": "aed58348-eb9e-42df-95f7-190969825df9", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"event_type\": \"contract_amendment.submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/webhook-callbacks/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "webhook-callbacks", "trigger" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-aed58348-eb9e-42df-95f7-190969825df9" }, { "id": "076d0171-1274-461c-bf63-4691e40c6d31", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"event_type\": \"contract_amendment.submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/webhook-callbacks/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "webhook-callbacks", "trigger" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-076d0171-1274-461c-bf63-4691e40c6d31" }, { "id": "751cd964-8c8b-440a-a8c2-a16ba5d10ec8", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"event_type\": \"contract_amendment.submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/sandbox/webhook-callbacks/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "webhook-callbacks", "trigger" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-751cd964-8c8b-440a-a8c2-a16ba5d10ec8" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-12822cf9-799d-4196-8a54-0ebca9c752d3" } ], "id": "59525417-af44-4769-a97f-e6f7e4e76cfc", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-59525417-af44-4769-a97f-e6f7e4e76cfc" } ], "id": "97c8e82e-b964-4218-857a-0e29f5c377e0", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-97c8e82e-b964-4218-857a-0e29f5c377e0" } ], "id": "9326391b-70c3-4eff-9679-a45f2cdca875", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-9326391b-70c3-4eff-9679-a45f2cdca875" }, { "name": "test-schema", "item": [ { "name": "Get a mock JSON Schema", "id": "4e355027-b4b4-4bdb-b029-6a5cd18f757f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/test-schema?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "test-schema" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Get a mock JSON Schema for testing purposes" }, "response": [ { "id": "8da763f2-4ed6-4c13-92db-fd049ad30ca8", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/test-schema?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "test-schema" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-8da763f2-4ed6-4c13-92db-fd049ad30ca8" } ], "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-4e355027-b4b4-4bdb-b029-6a5cd18f757f" } ], "id": "aa94b640-16d2-4676-9372-38da2aa0bab5", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-aa94b640-16d2-4676-9372-38da2aa0bab5" } ], "id": "f317a5a1-c9a0-47da-b7d9-8b03912f8535", "createdAt": "2026-07-28T02:47:57.000Z", "updatedAt": "2026-07-28T02:47:57.000Z", "uid": "35240-f317a5a1-c9a0-47da-b7d9-8b03912f8535" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://gateway.remote.com/" } ] }