{ "info": { "_postman_id": "c680ac28-c8b0-4c8d-bc88-32f2680e2372", "name": "Remote Address Details Sandbox API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:47:43.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-c680ac28-c8b0-4c8d-bc88-32f2680e2372" }, "item": [ { "name": "v1", "item": [ { "name": "sandbox", "item": [ { "name": "companies", "item": [ { "name": "{company_id}", "item": [ { "name": "bypass-eligibility-checks", "item": [ { "name": "Pass KYB", "id": "e403082e-0897-449d-8e23-3a31384cdc60", "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": "7a3085ea-4462-415e-8e6d-30f5483b4be3", "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": "324fad77-bb0d-45c9-a6f3-75f821a06134", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-324fad77-bb0d-45c9-a6f3-75f821a06134" }, { "id": "f2187169-c7d3-4687-a34b-35d4f7f5b4b1", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-f2187169-c7d3-4687-a34b-35d4f7f5b4b1" }, { "id": "d5366ec5-121a-43d3-8b36-cae19df3873a", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d5366ec5-121a-43d3-8b36-cae19df3873a" }, { "id": "97577057-b3e1-445b-8a56-a4bcf03c983d", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-97577057-b3e1-445b-8a56-a4bcf03c983d" }, { "id": "595ff681-4164-49e3-918f-2776667718a8", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-595ff681-4164-49e3-918f-2776667718a8" }, { "id": "55850d7c-b552-4b3a-97cf-9383b0f304fe", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-55850d7c-b552-4b3a-97cf-9383b0f304fe" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e403082e-0897-449d-8e23-3a31384cdc60" } ], "id": "b753930a-a9ab-48ad-b2c0-fd1ed582908d", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-b753930a-a9ab-48ad-b2c0-fd1ed582908d" }, { "name": "legal-entities", "item": [ { "name": "{legal_entity_id}", "item": [ { "name": "activate-global-payroll", "item": [ { "name": "Activate Global Payroll for a legal entity", "id": "c8adce7e-bd5e-4947-839f-05f4416223c8", "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": "b7c0d062-a624-4a15-8583-00328a8a6064", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "58e62e73-e775-4e42-85a2-e482b71b61ca", "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": "c1f538ad-1a7b-47e7-b70f-a3b76f4c1a77", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-c1f538ad-1a7b-47e7-b70f-a3b76f4c1a77" }, { "id": "043451f0-d26b-4114-a2f9-0bf79d6f7198", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-043451f0-d26b-4114-a2f9-0bf79d6f7198" }, { "id": "873c17de-2214-4029-8245-ae87357ae497", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-873c17de-2214-4029-8245-ae87357ae497" }, { "id": "15a6e051-fb7c-45b9-945d-d9dee2541b4e", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-15a6e051-fb7c-45b9-945d-d9dee2541b4e" }, { "id": "560dcee6-4cd4-40f6-962e-f0ab88d95401", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-560dcee6-4cd4-40f6-962e-f0ab88d95401" }, { "id": "4e6f1078-ff9d-4bf8-9389-7fd7ce3b0253", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-4e6f1078-ff9d-4bf8-9389-7fd7ce3b0253" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-c8adce7e-bd5e-4947-839f-05f4416223c8" } ], "id": "304206f2-50a5-4dd5-b323-0b6e3a9f4aeb", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-304206f2-50a5-4dd5-b323-0b6e3a9f4aeb" }, { "name": "set-credit-risk-status", "item": [ { "name": "Set company credit risk status", "id": "9bca8a3e-72df-458d-85cd-4bd094b55819", "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": "9942fcf5-7dcf-4d40-806f-35ff82d25d4f", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "ab26095e-8a30-4f9b-8a9a-c45aad01d014", "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": "41da5de6-6c19-4bbd-bd6f-b49d37fa0171", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-41da5de6-6c19-4bbd-bd6f-b49d37fa0171" }, { "id": "4d98acd5-8d22-43b3-ad2a-cf17b1693fbe", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-4d98acd5-8d22-43b3-ad2a-cf17b1693fbe" }, { "id": "a2e720b2-c466-4ce5-bc66-93e4db8287b9", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-a2e720b2-c466-4ce5-bc66-93e4db8287b9" }, { "id": "a042c312-8a3c-4a40-a017-0182f2c8cf1e", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-a042c312-8a3c-4a40-a017-0182f2c8cf1e" }, { "id": "646b653e-bd79-4d31-8c69-5298cf2412a1", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-646b653e-bd79-4d31-8c69-5298cf2412a1" }, { "id": "51787aa2-eae6-4eda-8688-3873662bde3a", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-51787aa2-eae6-4eda-8688-3873662bde3a" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-9bca8a3e-72df-458d-85cd-4bd094b55819" } ], "id": "e0ef8398-cbad-4f30-8cbd-14bea94d9227", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e0ef8398-cbad-4f30-8cbd-14bea94d9227" } ], "id": "4fbd1e94-64b9-409b-bce8-71977c416843", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-4fbd1e94-64b9-409b-bce8-71977c416843" }, { "name": "Create a legal entity", "id": "9166e549-bf9b-41b3-b958-ccf43aefef61", "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": "5d9af65c-5084-4aee-b9e5-3621d92f2b24", "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": "b7222ef9-c3b4-4155-930c-b261b446f242", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-b7222ef9-c3b4-4155-930c-b261b446f242" }, { "id": "5bf1d1e0-da97-4132-bec3-cf84eebf111f", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-5bf1d1e0-da97-4132-bec3-cf84eebf111f" }, { "id": "4e0cd8fd-ce06-47aa-9b11-24ef86ee34e3", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-4e0cd8fd-ce06-47aa-9b11-24ef86ee34e3" }, { "id": "d30b0fcf-264e-46e4-8173-d445009bde47", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d30b0fcf-264e-46e4-8173-d445009bde47" }, { "id": "069fc7d7-b150-4705-93d8-469492875b71", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-069fc7d7-b150-4705-93d8-469492875b71" }, { "id": "10e9f1f5-2e36-43a1-a5f9-35545dcd3d21", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-10e9f1f5-2e36-43a1-a5f9-35545dcd3d21" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-9166e549-bf9b-41b3-b958-ccf43aefef61" } ], "id": "e2b8e2bc-008f-47a5-8df2-3c68a884c78a", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e2b8e2bc-008f-47a5-8df2-3c68a884c78a" }, { "name": "default-legal-entity", "item": [ { "name": "{legal_entity_id}", "item": [ { "name": "Reassign default legal entity", "id": "5a3d0cc3-39c3-454a-b908-44277494c5c2", "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": "18c9a432-8bfb-442d-9662-6b5b7d0fb2f7", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "493f5e81-44c0-4c64-bcef-f158fe991b0c", "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": "0480c452-1de0-4657-b5e1-81e212d33268", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-0480c452-1de0-4657-b5e1-81e212d33268" }, { "id": "0c7c16f7-a997-4591-b5e8-6cfc2d7a56c3", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-0c7c16f7-a997-4591-b5e8-6cfc2d7a56c3" }, { "id": "04348c33-aad1-4d71-979a-b4344af9154e", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-04348c33-aad1-4d71-979a-b4344af9154e" }, { "id": "fe8c2cde-a90e-4002-9644-18702139dd13", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-fe8c2cde-a90e-4002-9644-18702139dd13" }, { "id": "9b042ce4-b1ab-4e55-b678-9ba89b69d65b", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-9b042ce4-b1ab-4e55-b678-9ba89b69d65b" }, { "id": "6b9131e6-a5e8-4ee0-a8c9-9b1966e389f7", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6b9131e6-a5e8-4ee0-a8c9-9b1966e389f7" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-5a3d0cc3-39c3-454a-b908-44277494c5c2" } ], "id": "f665fb82-12a4-4ac6-bd30-2db8a34092f1", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-f665fb82-12a4-4ac6-bd30-2db8a34092f1" } ], "id": "e7244053-a691-4833-8be3-2e1863b2a9fe", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e7244053-a691-4833-8be3-2e1863b2a9fe" } ], "id": "88226467-ece6-4c1e-b540-3935fdecf43a", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-88226467-ece6-4c1e-b540-3935fdecf43a" } ], "id": "aed58e37-5865-434b-81de-fc7c32036b2e", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-aed58e37-5865-434b-81de-fc7c32036b2e" }, { "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": "7e2177b1-5d06-407b-8938-efddfcf04745", "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": "55fd7cdd-fa01-4ad2-84a1-ec41f4c19fa3", "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": "8131a5ef-3edd-4ca1-94d1-cd577644b278", "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\": \"pending\"\n }\n}", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-8131a5ef-3edd-4ca1-94d1-cd577644b278" }, { "id": "cc2f1746-f130-4888-bb77-7bfc1a93390c", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-cc2f1746-f130-4888-bb77-7bfc1a93390c" }, { "id": "9d3002b2-e1bc-4319-a42d-445a6df90c84", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-9d3002b2-e1bc-4319-a42d-445a6df90c84" }, { "id": "f89e0c87-b76a-4fad-a794-d44fe306f5ef", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-f89e0c87-b76a-4fad-a794-d44fe306f5ef" }, { "id": "88d997a4-4cfd-415e-b1be-d0bb99dd7c3b", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-88d997a4-4cfd-415e-b1be-d0bb99dd7c3b" }, { "id": "138ee28f-0096-479c-8a9f-57e8a0f8a24f", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-138ee28f-0096-479c-8a9f-57e8a0f8a24f" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-7e2177b1-5d06-407b-8938-efddfcf04745" } ], "id": "63b6c531-e21c-4cef-8e48-e01fc133a596", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-63b6c531-e21c-4cef-8e48-e01fc133a596" } ], "id": "414b00bb-0b52-445d-b91a-dfa49c2b111c", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-414b00bb-0b52-445d-b91a-dfa49c2b111c" }, { "name": "Archive employment", "id": "b0d90d9c-1a96-4e18-81ba-868d5e6c81ca", "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": "5d47eee0-395a-40ee-a74d-bea4f80af7f8", "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": "7c724ac5-4ba0-4437-a207-2e1305857ce9", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-7c724ac5-4ba0-4437-a207-2e1305857ce9" }, { "id": "4b50ef3f-f7e4-42e2-87ac-d9ff46509f7a", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-4b50ef3f-f7e4-42e2-87ac-d9ff46509f7a" }, { "id": "19233806-876a-46d9-9563-58449c250f4e", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-19233806-876a-46d9-9563-58449c250f4e" }, { "id": "7a86b1e5-b05b-4574-9eee-b8f63a554ec3", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-7a86b1e5-b05b-4574-9eee-b8f63a554ec3" }, { "id": "f6cad8fa-f74c-4359-8e7c-31bdb5edffe0", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-f6cad8fa-f74c-4359-8e7c-31bdb5edffe0" }, { "id": "6d4e37bf-75d9-42bd-a1b2-d56d3c653c41", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6d4e37bf-75d9-42bd-a1b2-d56d3c653c41" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-b0d90d9c-1a96-4e18-81ba-868d5e6c81ca" }, { "name": "Update employment", "id": "42aac2c2-cd57-4243-a7b3-ace2ee4d41c6", "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\": \"active\"\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": "5b559808-4400-48bf-a76e-0851cfa8d190", "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": "a114667b-d6a1-404b-a4af-55b4b3b1b3f2", "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\": \"active\"\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\": \"contractor\",\n \"employment_model\": \"eor\",\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\": \"completed\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"pre_hire\",\n \"employment_lifecycle_stage\": \"onboarded\",\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\": \"cor\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"semi_monthly\",\n \"slug\": \"\",\n \"type\": \"one_off\"\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\": \"initiated\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-a114667b-d6a1-404b-a4af-55b4b3b1b3f2" }, { "id": "9983979b-ffab-491a-8bec-c07234ade080", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-9983979b-ffab-491a-8bec-c07234ade080" }, { "id": "f558c789-1522-47b1-8577-60d285196a53", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-f558c789-1522-47b1-8577-60d285196a53" }, { "id": "c9e68d8b-d801-4acb-8455-37ee3b8420fa", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-c9e68d8b-d801-4acb-8455-37ee3b8420fa" }, { "id": "6a6fe4c3-e783-4ff7-9274-74e0d818fd54", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6a6fe4c3-e783-4ff7-9274-74e0d818fd54" }, { "id": "856b912d-f588-4ca1-a399-356dc7c2c05d", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-856b912d-f588-4ca1-a399-356dc7c2c05d" }, { "id": "2f3960cf-d710-481d-bd07-374edb575d72", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-2f3960cf-d710-481d-bd07-374edb575d72" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-42aac2c2-cd57-4243-a7b3-ace2ee4d41c6" }, { "name": "Update employment", "id": "44f3a02b-3bd5-44c1-82ef-c5b3718ed04f", "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\": \"active\"\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": "eb06590a-0064-4cba-95ec-7713097e2776", "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": "6b10098f-6526-4038-a5fa-f04a888d2caa", "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\": \"active\"\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\": \"contractor\",\n \"employment_model\": \"eor\",\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\": \"completed\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"pre_hire\",\n \"employment_lifecycle_stage\": \"onboarded\",\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\": \"cor\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"semi_monthly\",\n \"slug\": \"\",\n \"type\": \"one_off\"\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\": \"initiated\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6b10098f-6526-4038-a5fa-f04a888d2caa" }, { "id": "0ffca950-c577-4d3c-89dd-f1d2088b5ea4", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-0ffca950-c577-4d3c-89dd-f1d2088b5ea4" }, { "id": "6239d7c9-e435-4051-8e6a-c183750541c6", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6239d7c9-e435-4051-8e6a-c183750541c6" }, { "id": "4f541796-8a47-4fef-8eef-0aaaa8bea4d5", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-4f541796-8a47-4fef-8eef-0aaaa8bea4d5" }, { "id": "e44aaade-2532-4ceb-a4e8-87cf111cd792", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e44aaade-2532-4ceb-a4e8-87cf111cd792" }, { "id": "21735ae6-3487-4030-af73-4515a2dc8ace", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-21735ae6-3487-4030-af73-4515a2dc8ace" }, { "id": "9e63940f-1ab5-4c42-9171-d3ef949c102b", "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\": \"active\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-9e63940f-1ab5-4c42-9171-d3ef949c102b" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-44f3a02b-3bd5-44c1-82ef-c5b3718ed04f" } ], "id": "8b44f03b-c979-441c-80f4-cc8cef84c1f2", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-8b44f03b-c979-441c-80f4-cc8cef84c1f2" }, { "name": "Create employment", "id": "157f096c-0a09-4908-ab8d-fc6260b2fe6e", "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": "92c6df8e-3326-4b8e-acbf-d0d0acc0ce66", "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\": \"employee_self_enrollment\",\n \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"login_email\": \"\",\n \"personal_email\": \"\",\n \"provisional_start_date\": \"\",\n \"type\": \"contractor\",\n \"updated_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-92c6df8e-3326-4b8e-acbf-d0d0acc0ce66" }, { "id": "d3aac344-9aea-4f58-80a7-4ff2dfee1c30", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d3aac344-9aea-4f58-80a7-4ff2dfee1c30" }, { "id": "0b2a934f-45e7-4584-8385-abfacc4f744d", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-0b2a934f-45e7-4584-8385-abfacc4f744d" }, { "id": "deff859a-b09a-4c8b-982b-a201bf1a2bf3", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-deff859a-b09a-4c8b-982b-a201bf1a2bf3" }, { "id": "94e924ed-a223-402e-b970-f4b37279ddc3", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-94e924ed-a223-402e-b970-f4b37279ddc3" }, { "id": "d7ba4751-741f-496c-a880-2c72e8981b2f", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d7ba4751-741f-496c-a880-2c72e8981b2f" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-157f096c-0a09-4908-ab8d-fc6260b2fe6e" } ], "id": "d0585ca9-b136-4546-9b71-5c25780a7f5e", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d0585ca9-b136-4546-9b71-5c25780a7f5e" }, { "name": "benefit-renewal-requests", "item": [ { "name": "Creates a Benefit Renewal Request", "id": "c8fa20c3-856f-4403-b50f-ac728c8eca7f", "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": "340efd3a-c36a-486b-9a37-d31feb91f617", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-340efd3a-c36a-486b-9a37-d31feb91f617" }, { "id": "b9714e6c-296e-4f07-87f3-2416a06b1d55", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-b9714e6c-296e-4f07-87f3-2416a06b1d55" }, { "id": "e8e73f39-7317-450f-bdaf-94a64dbcd71c", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e8e73f39-7317-450f-bdaf-94a64dbcd71c" }, { "id": "3e194e8b-37e7-4e50-ac6f-88f96c9770b8", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-3e194e8b-37e7-4e50-ac6f-88f96c9770b8" }, { "id": "d21c72c3-086c-4fc3-b1cc-1562ab070388", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d21c72c3-086c-4fc3-b1cc-1562ab070388" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-c8fa20c3-856f-4403-b50f-ac728c8eca7f" } ], "id": "2d32ddcd-1181-40fd-8cdd-2769feb1fac2", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-2d32ddcd-1181-40fd-8cdd-2769feb1fac2" }, { "name": "contract-amendments", "item": [ { "name": "{contract_amendment_request_id}", "item": [ { "name": "approve", "item": [ { "name": "Approve Contract Amendment", "id": "545b2eed-d303-4156-9c80-abe124ecbb5f", "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": "ccb61852-0e7b-4925-8f38-87e415d2d961", "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": "b31971af-f662-41c1-868f-4ae2b4156cd2", "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\": \"done\",\n \"requested_by\": \"\",\n \"submitted_at\": \"\",\n \"request_details\": {\n \"additional_comments\": \"\",\n \"effective_date\": \"\",\n \"reason_for_change\": \"annual_pay_adjustment\",\n \"reason_for_change_description\": \"\",\n \"salary_decrease_details\": {\n \"salary_decrease_reason\": \"change_in_working_hours\",\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-b31971af-f662-41c1-868f-4ae2b4156cd2" }, { "id": "e3993d49-3679-418e-ac18-8bac149c78ab", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e3993d49-3679-418e-ac18-8bac149c78ab" }, { "id": "d4e31794-3847-4bc2-a9b8-81191184a002", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-d4e31794-3847-4bc2-a9b8-81191184a002" }, { "id": "87fbc279-3d81-40f1-98f7-b773db716278", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-87fbc279-3d81-40f1-98f7-b773db716278" }, { "id": "74b80714-596e-402e-a4bb-4155686c66e3", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-74b80714-596e-402e-a4bb-4155686c66e3" }, { "id": "bd39a560-4836-4fea-b0d6-e1608b37a007", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-bd39a560-4836-4fea-b0d6-e1608b37a007" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-545b2eed-d303-4156-9c80-abe124ecbb5f" } ], "id": "7fbba2c4-f6d7-4a12-b26b-3fdc4839e4f4", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-7fbba2c4-f6d7-4a12-b26b-3fdc4839e4f4" }, { "name": "cancel", "item": [ { "name": "Cancel Contract Amendment", "id": "da6b3caa-afd5-45bd-8e1c-0a4b3e9fd849", "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": "f5f48dad-7556-48cb-90d2-1a2c77fe9d7a", "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": "6e59b97c-3fc4-431d-99b7-f56cbc77cc2e", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6e59b97c-3fc4-431d-99b7-f56cbc77cc2e" }, { "id": "b0602bd9-0321-4137-b562-cec43590a5b0", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-b0602bd9-0321-4137-b562-cec43590a5b0" }, { "id": "6b7fc65e-4a2b-4bc4-96d9-1b5c0d2ea57e", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6b7fc65e-4a2b-4bc4-96d9-1b5c0d2ea57e" }, { "id": "269a958e-f459-433e-bd72-e43426c36b8c", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-269a958e-f459-433e-bd72-e43426c36b8c" }, { "id": "17a3eaa2-e021-46e2-a909-d4df144a391b", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-17a3eaa2-e021-46e2-a909-d4df144a391b" }, { "id": "6d181a03-6924-4297-b39e-f0ae5488b996", "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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-6d181a03-6924-4297-b39e-f0ae5488b996" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-da6b3caa-afd5-45bd-8e1c-0a4b3e9fd849" } ], "id": "66a8ea60-4d05-4be6-8279-47b5c4891cbb", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-66a8ea60-4d05-4be6-8279-47b5c4891cbb" } ], "id": "abbd42d9-97eb-41f3-a723-8bf3e351b1e8", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-abbd42d9-97eb-41f3-a723-8bf3e351b1e8" } ], "id": "df8abf67-608e-4e36-a655-7aba54761c06", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-df8abf67-608e-4e36-a655-7aba54761c06" }, { "name": "webhook-callbacks", "item": [ { "name": "trigger", "item": [ { "name": "Trigger a Webhook", "id": "e70bb53e-b091-47a3-a585-67f314b0f30c", "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\": \"sso_configuration.disabled\"\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": "704bdffb-9da5-46cc-999b-7549e973e13b", "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\": \"sso_configuration.disabled\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-704bdffb-9da5-46cc-999b-7549e973e13b" }, { "id": "f7d6ee59-f3cb-462f-8b4d-144b0d417cdb", "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\": \"sso_configuration.disabled\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-f7d6ee59-f3cb-462f-8b4d-144b0d417cdb" }, { "id": "e70526b5-6e05-4e1d-bcd0-d2c16a89beb0", "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\": \"sso_configuration.disabled\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e70526b5-6e05-4e1d-bcd0-d2c16a89beb0" }, { "id": "67e97418-9189-4caa-97d2-c462a41caf3e", "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\": \"sso_configuration.disabled\"\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:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-67e97418-9189-4caa-97d2-c462a41caf3e" } ], "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-e70bb53e-b091-47a3-a585-67f314b0f30c" } ], "id": "11e9c275-39c6-46d2-8961-8a4355c1c33a", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-11e9c275-39c6-46d2-8961-8a4355c1c33a" } ], "id": "0451196b-4498-4df9-82ef-ff5d5b2a90a1", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-0451196b-4498-4df9-82ef-ff5d5b2a90a1" } ], "id": "53dd4426-23ed-4dd7-896c-f99c22bc65ee", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-53dd4426-23ed-4dd7-896c-f99c22bc65ee" } ], "id": "dcee3dee-5e0f-4e74-abae-75e8d99088ef", "createdAt": "2026-07-28T02:47:44.000Z", "updatedAt": "2026-07-28T02:47:44.000Z", "uid": "35240-dcee3dee-5e0f-4e74-abae-75e8d99088ef" } ], "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/" } ] }