{ "info": { "_postman_id": "248e54dc-3aa7-417f-9448-3b6406d6a072", "name": "Remote Address Details Employments API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:46:01.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "lastUpdatedBy": "35240", "uid": "35240-248e54dc-3aa7-417f-9448-3b6406d6a072" }, "item": [ { "name": "v2", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "pricing-plan-details", "item": [ { "name": "Update pricing plan details", "id": "d4a65e07-b9f7-401c-ba1e-046bb8f8130a", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "variable": [ { "id": "8f3e7c49-4d54-4037-baad-39ce35485af5", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates the pricing plan for an employment. The frequency determines how often Remote bills the\nemployer for management fees. Annual billing typically offers a discount.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "0b46dcd2-6f15-4b33-b408-bdc000ade37e", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0b46dcd2-6f15-4b33-b408-bdc000ade37e" }, { "id": "ad85d0c5-30ad-4a92-a414-4227c6bd9ad2", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ad85d0c5-30ad-4a92-a414-4227c6bd9ad2" }, { "id": "2834d36b-0e18-4e74-9ec9-bc746f0e25d4", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2834d36b-0e18-4e74-9ec9-bc746f0e25d4" }, { "id": "8b0083f1-4d53-42c8-90b7-100569d1bd49", "name": "Forbidden", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8b0083f1-4d53-42c8-90b7-100569d1bd49" }, { "id": "c8f901e8-2444-4837-9270-84b752680e59", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c8f901e8-2444-4837-9270-84b752680e59" }, { "id": "bedab792-22c1-4893-aa96-59421be278d6", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bedab792-22c1-4893-aa96-59421be278d6" }, { "id": "4ea6df13-4982-4dd0-be0a-642844feb84f", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4ea6df13-4982-4dd0-be0a-642844feb84f" }, { "id": "baf60cc8-d2c3-42b7-8b20-6528d848a611", "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 \"pricing_plan_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/pricing-plan-details?pricing_plan_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "pricing-plan-details" ], "query": [ { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-baf60cc8-d2c3-42b7-8b20-6528d848a611" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d4a65e07-b9f7-401c-ba1e-046bb8f8130a" } ], "id": "077e265c-9a80-4805-9cbc-6597a3c1a295", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-077e265c-9a80-4805-9cbc-6597a3c1a295" }, { "name": "address-details", "item": [ { "name": "Update address details", "id": "d5ad7f89-845d-4ca3-9399-07cea72bc39c", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "variable": [ { "id": "e0a36dd8-1b28-406f-9894-8e130f7f0d9c", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's address details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "a740c8f6-f081-4a20-8c11-50ff79e9f3ea", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a740c8f6-f081-4a20-8c11-50ff79e9f3ea" }, { "id": "081ecd62-8025-48ff-8d93-3f0e02409a88", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-081ecd62-8025-48ff-8d93-3f0e02409a88" }, { "id": "865af270-570a-4344-937c-7c3d6f1b3e63", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-865af270-570a-4344-937c-7c3d6f1b3e63" }, { "id": "6225cab0-5c85-4edd-a7e1-6880ce14b5e5", "name": "Forbidden", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6225cab0-5c85-4edd-a7e1-6880ce14b5e5" }, { "id": "6bb7dd3c-1fb2-4907-ab9a-e13f4fcf4355", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6bb7dd3c-1fb2-4907-ab9a-e13f4fcf4355" }, { "id": "835711cc-2ff5-488f-87a2-97ff0a01fa01", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-835711cc-2ff5-488f-87a2-97ff0a01fa01" }, { "id": "172a6d62-56b2-4d6d-b7c8-b690b1ef0250", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-172a6d62-56b2-4d6d-b7c8-b690b1ef0250" }, { "id": "d7153b13-e7e5-4443-b474-50c92ecd9654", "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 \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/address-details?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "address-details" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d7153b13-e7e5-4443-b474-50c92ecd9654" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d5ad7f89-845d-4ca3-9399-07cea72bc39c" } ], "id": "5e23ee80-61f9-4aae-96bb-c2e0aa16724e", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5e23ee80-61f9-4aae-96bb-c2e0aa16724e" }, { "name": "engagement-agreement-details", "item": [ { "name": "Get engagement agreement details", "id": "daa2bd4a-a3bd-47b6-8171-e940b4659c2a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "id": "3dc4d1bd-6cfb-4afb-acec-da911ef2cabb", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the engagement agreement details for an employment.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "51a90ce2-75c0-4a67-a6ff-51284a06e695", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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 \"details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-51a90ce2-75c0-4a67-a6ff-51284a06e695" }, { "id": "60946452-0213-48d3-893d-0b410b1aa2b8", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-60946452-0213-48d3-893d-0b410b1aa2b8" }, { "id": "6e4c2f63-7a5d-4db2-99a0-dbd26143e987", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6e4c2f63-7a5d-4db2-99a0-dbd26143e987" }, { "id": "70c11d6e-65f1-4825-9eec-dd8379475fd7", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-70c11d6e-65f1-4825-9eec-dd8379475fd7" }, { "id": "b2e8929b-4c17-454d-a784-df1b2fd55531", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b2e8929b-4c17-454d-a784-df1b2fd55531" }, { "id": "982f434c-fe4c-4711-bba0-ed056e284396", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-982f434c-fe4c-4711-bba0-ed056e284396" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-daa2bd4a-a3bd-47b6-8171-e940b4659c2a" }, { "name": "Upsert engagement agreement details", "id": "7720fb76-ce3b-47c1-9fdf-724e6b95ab27", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "id": "d586a314-f52e-48dd-a8cf-96f9ecba0841", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Creates or updates the engagement agreement details for an employment.\n\nThis endpoint requires country-specific data. The exact required fields will vary depending on\nwhich country the employment is in. To see the list of parameters for each country, see the\n**Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that compliance requirements for each country are subject to change according to local laws.\nUsing Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended\nto avoid compliance issues and to have the latest version of a country's requirements.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "bbaed038-e5f7-4e44-8b6e-a9ed086a3a0d", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bbaed038-e5f7-4e44-8b6e-a9ed086a3a0d" }, { "id": "4fd402e2-7704-4532-b73a-1ea6b0dfff15", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4fd402e2-7704-4532-b73a-1ea6b0dfff15" }, { "id": "6d343bac-7873-42b5-b397-6d4492e1d815", "name": "Forbidden", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6d343bac-7873-42b5-b397-6d4492e1d815" }, { "id": "a8434251-7133-4913-aa17-e294f3bd6836", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a8434251-7133-4913-aa17-e294f3bd6836" }, { "id": "6bba3a0b-1486-4d67-bfa2-da3bb9f0eeda", "name": "Conflict", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6bba3a0b-1486-4d67-bfa2-da3bb9f0eeda" }, { "id": "b76ff84e-213c-4ef1-8ccb-b74830bb207c", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b76ff84e-213c-4ef1-8ccb-b74830bb207c" }, { "id": "b2e04e34-ae50-4153-b821-cd245ca18d4c", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b2e04e34-ae50-4153-b821-cd245ca18d4c" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7720fb76-ce3b-47c1-9fdf-724e6b95ab27" } ], "id": "a8f782d0-9603-4994-928b-51c57b9ac5d2", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a8f782d0-9603-4994-928b-51c57b9ac5d2" }, { "name": "federal-taxes", "item": [ { "name": "Update federal taxes", "id": "2948efe1-32fe-4edc-ba30-4abea87a415a", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "variable": [ { "id": "e81f2a36-3a14-49bb-a2dd-37668cd5c869", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's federal taxes.\n\nRequirements to update federal taxes successfully:\n* Employment should be Global Payroll\n* Employment should be in the post-enrollment state\n* Employment should belong to USA\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "78064cd2-e244-45d5-9631-35710abf08e4", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-78064cd2-e244-45d5-9631-35710abf08e4" }, { "id": "3699c590-9205-4c23-8945-092628562925", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3699c590-9205-4c23-8945-092628562925" }, { "id": "8ff20d7e-f7fd-487b-81f9-49967632b731", "name": "Forbidden", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8ff20d7e-f7fd-487b-81f9-49967632b731" }, { "id": "d0e46733-e9f4-4704-9a07-17af81ba2750", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d0e46733-e9f4-4704-9a07-17af81ba2750" }, { "id": "b6b950cc-2f24-45ac-b5de-39f2d44e3812", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b6b950cc-2f24-45ac-b5de-39f2d44e3812" }, { "id": "730bb4b1-f7dd-450e-862a-c3c2d1e53289", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-730bb4b1-f7dd-450e-862a-c3c2d1e53289" }, { "id": "5d52202c-06dc-42ff-b7b9-e866b16acb66", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5d52202c-06dc-42ff-b7b9-e866b16acb66" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2948efe1-32fe-4edc-ba30-4abea87a415a" } ], "id": "8e57bba3-fd35-479f-aa1a-e9bd982bbad2", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8e57bba3-fd35-479f-aa1a-e9bd982bbad2" }, { "name": "basic-information", "item": [ { "name": "Get basic information", "id": "92f36d9b-1ed9-49b4-8e2d-c1ef8629218f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "variable": [ { "id": "86af376e-57f1-4a7e-adf8-ffc14451b261", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the employment's basic information.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "9b7324d5-00c6-4465-bdb2-97a8b2d45e3f", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9b7324d5-00c6-4465-bdb2-97a8b2d45e3f" }, { "id": "f85dbbf7-dfc8-4b9f-9475-d742c4a73b08", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f85dbbf7-dfc8-4b9f-9475-d742c4a73b08" }, { "id": "68f48f0d-ebe1-4974-ad12-0cbd34f20757", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-68f48f0d-ebe1-4974-ad12-0cbd34f20757" }, { "id": "10263a5c-0036-4bae-922a-382658011a91", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-10263a5c-0036-4bae-922a-382658011a91" }, { "id": "8938ec48-d9db-4fa3-830b-0027c6f4823e", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8938ec48-d9db-4fa3-830b-0027c6f4823e" }, { "id": "2306c87e-74f5-4772-96d3-ba949e9d30cb", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2306c87e-74f5-4772-96d3-ba949e9d30cb" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-92f36d9b-1ed9-49b4-8e2d-c1ef8629218f" }, { "name": "Update basic information", "id": "85b35ff6-aebc-40c9-bd99-19560cb97a4c", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "variable": [ { "id": "b979f6d5-5d77-4293-b933-1d29a80c3f76", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's basic information.\n\nSupported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "cc76768e-706f-4587-beb7-5336e15a36a8", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cc76768e-706f-4587-beb7-5336e15a36a8" }, { "id": "e19d8d88-eae4-4758-95be-b5438f3f8df5", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e19d8d88-eae4-4758-95be-b5438f3f8df5" }, { "id": "91a379c0-5685-4b39-a84e-3fba06aa7e3f", "name": "Forbidden", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-91a379c0-5685-4b39-a84e-3fba06aa7e3f" }, { "id": "f4566653-9dcb-433d-b4ba-f915fd671140", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f4566653-9dcb-433d-b4ba-f915fd671140" }, { "id": "04d4b93f-b4d6-4440-aa4e-dbb8f49462bc", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-04d4b93f-b4d6-4440-aa4e-dbb8f49462bc" }, { "id": "c12949b1-5f74-48b7-8a6b-055ab3d6b0c2", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/basic-information?employment_basic_information_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "basic-information" ], "query": [ { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c12949b1-5f74-48b7-8a6b-055ab3d6b0c2" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-85b35ff6-aebc-40c9-bd99-19560cb97a4c" } ], "id": "53709de7-a36e-43f9-964f-cb92ce8249e4", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-53709de7-a36e-43f9-964f-cb92ce8249e4" }, { "name": "emergency-contact", "item": [ { "name": "Update emergency contact", "id": "0dd67a05-ee2e-4e2a-89bf-226021004515", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "variable": [ { "id": "94bfbea9-7ca1-4f7d-bb38-0a038923962a", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates the employment's emergency contact details.\n\nThis endpoint requires country-specific data. Query the **Show form schema** endpoint\npassing the country code and `emergency_contact_details` as path parameters to see\nthe required fields for a given country.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "f2101401-c3ef-483c-b128-c2a404384dc9", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f2101401-c3ef-483c-b128-c2a404384dc9" }, { "id": "71ffb588-74d6-4af6-a190-fbf795ae8441", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-71ffb588-74d6-4af6-a190-fbf795ae8441" }, { "id": "f1692bb8-736c-4004-9465-759b8cc5eb81", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f1692bb8-736c-4004-9465-759b8cc5eb81" }, { "id": "4d887c09-d16a-441a-98e1-e9e9a5070b09", "name": "Forbidden", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4d887c09-d16a-441a-98e1-e9e9a5070b09" }, { "id": "02d688f8-de48-4023-b0c1-20cf4093386b", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-02d688f8-de48-4023-b0c1-20cf4093386b" }, { "id": "ddcdb812-7604-4cc7-b2bd-bd45aa22dcc0", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ddcdb812-7604-4cc7-b2bd-bd45aa22dcc0" }, { "id": "51e018f2-354e-420e-a17a-527679c7e293", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-51e018f2-354e-420e-a17a-527679c7e293" }, { "id": "c9a7c470-b719-4898-8111-080991047555", "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 \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c9a7c470-b719-4898-8111-080991047555" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0dd67a05-ee2e-4e2a-89bf-226021004515" } ], "id": "0f22261b-150e-4dbe-b38d-16e2a0937920", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0f22261b-150e-4dbe-b38d-16e2a0937920" }, { "name": "contract-details", "item": [ { "name": "Update contract details", "id": "647fcb05-10b9-49b1-b532-26e10b3e950b", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "variable": [ { "id": "8b8a8a95-0d63-447a-bbb6-feac63d4a066", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's contract details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "a8e6a36e-44ad-4338-aa38-416bc5c0bc7b", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a8e6a36e-44ad-4338-aa38-416bc5c0bc7b" }, { "id": "ff82871f-b5be-453c-93c9-a68a7f7184a8", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ff82871f-b5be-453c-93c9-a68a7f7184a8" }, { "id": "40609981-c235-4753-82ef-eaa642c69319", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-40609981-c235-4753-82ef-eaa642c69319" }, { "id": "fe932945-bfaf-476e-a261-8420bcd6f02f", "name": "Forbidden", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fe932945-bfaf-476e-a261-8420bcd6f02f" }, { "id": "6668d761-c97b-4e19-bc79-d3a689ac5a00", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6668d761-c97b-4e19-bc79-d3a689ac5a00" }, { "id": "72dce937-7747-47ba-a8e8-5a15277ad06e", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-72dce937-7747-47ba-a8e8-5a15277ad06e" }, { "id": "dcb2e8d1-ebd5-414e-bfa7-8dbc885cb3cd", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-dcb2e8d1-ebd5-414e-bfa7-8dbc885cb3cd" }, { "id": "ea514d45-7a2a-414f-80e4-9dfdc69ad190", "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 \"contract_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/contract-details?contract_details_json_schema_version=&skip_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "contract-details" ], "query": [ { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ea514d45-7a2a-414f-80e4-9dfdc69ad190" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-647fcb05-10b9-49b1-b532-26e10b3e950b" } ], "id": "15298f54-e1aa-4a23-b6ce-f53f3cba1a58", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-15298f54-e1aa-4a23-b6ce-f53f3cba1a58" }, { "name": "bank-account-details", "item": [ { "name": "Update bank account details", "id": "d3bfb9bd-493c-4465-b261-fb1d4f205cbf", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "id": "7e472c77-cddb-45f3-9724-5956b40f3737", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's bank account details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "3f092ce8-a14b-4afd-83bc-983746665121", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3f092ce8-a14b-4afd-83bc-983746665121" }, { "id": "27378489-0baf-4f1f-8fb2-066ce906344e", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-27378489-0baf-4f1f-8fb2-066ce906344e" }, { "id": "60c6daff-441b-40b7-bfae-18fb20a23123", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-60c6daff-441b-40b7-bfae-18fb20a23123" }, { "id": "93613d5a-6f7f-4409-8bfd-40b3144fa9c6", "name": "Forbidden", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-93613d5a-6f7f-4409-8bfd-40b3144fa9c6" }, { "id": "ebd72b38-95d5-4db6-bcd1-237aeb822f81", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ebd72b38-95d5-4db6-bcd1-237aeb822f81" }, { "id": "47084708-1245-4ffc-bbb9-b5bd02d796ae", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-47084708-1245-4ffc-bbb9-b5bd02d796ae" }, { "id": "99fc8405-be68-4025-a433-a5046ab31f9b", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-99fc8405-be68-4025-a433-a5046ab31f9b" }, { "id": "4b4f1f4c-aa4f-40f6-9e41-cb060683703a", "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 \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/bank-account-details?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "bank-account-details" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4b4f1f4c-aa4f-40f6-9e41-cb060683703a" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d3bfb9bd-493c-4465-b261-fb1d4f205cbf" } ], "id": "fdedbc80-e871-4fae-a1e1-b17fd5a3c16e", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fdedbc80-e871-4fae-a1e1-b17fd5a3c16e" }, { "name": "personal-details", "item": [ { "name": "Update personal details", "id": "9e70e990-5f89-4460-90f4-2def22c0ff32", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "variable": [ { "id": "9fcd94c2-8933-4a5f-90ce-cdab26e23047", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's personal details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "e4a266e5-9c31-4743-86f1-6af386ec6923", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e4a266e5-9c31-4743-86f1-6af386ec6923" }, { "id": "d9a03b43-689b-4ab8-9b8c-f36b15df42ab", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d9a03b43-689b-4ab8-9b8c-f36b15df42ab" }, { "id": "d13cd245-75bf-4d41-a0f3-c37b1b2b473e", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d13cd245-75bf-4d41-a0f3-c37b1b2b473e" }, { "id": "722817d3-0f27-446f-8f82-981950173356", "name": "Forbidden", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-722817d3-0f27-446f-8f82-981950173356" }, { "id": "77bce847-657b-4983-90f2-32538e5b5578", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-77bce847-657b-4983-90f2-32538e5b5578" }, { "id": "bb43de4e-e92f-43f9-b832-f7524ada79b7", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bb43de4e-e92f-43f9-b832-f7524ada79b7" }, { "id": "b2f01d37-b7df-43b3-9911-d82958258ade", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b2f01d37-b7df-43b3-9911-d82958258ade" }, { "id": "1bfa83fd-8a4f-4229-a65a-b91ae76883b8", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1bfa83fd-8a4f-4229-a65a-b91ae76883b8" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9e70e990-5f89-4460-90f4-2def22c0ff32" } ], "id": "c76395ce-5435-4ef2-b5bb-a660e2286348", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c76395ce-5435-4ef2-b5bb-a660e2286348" }, { "name": "billing-address-details", "item": [ { "name": "Update billing address details", "id": "9b086a7a-d2ae-43c7-abc9-88bc79043b4f", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "variable": [ { "id": "d5ca96c4-014d-4aa6-baeb-dc0dab875c0c", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's billing address details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "0cfd8e39-886d-44c6-8a2d-384d8f847c4a", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0cfd8e39-886d-44c6-8a2d-384d8f847c4a" }, { "id": "9a7efeda-dd94-4ea2-874e-58b393a1d7b6", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9a7efeda-dd94-4ea2-874e-58b393a1d7b6" }, { "id": "32a083cd-8439-4222-91f7-f0492bdc7b9d", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-32a083cd-8439-4222-91f7-f0492bdc7b9d" }, { "id": "d6c8ad73-370f-4f64-b35e-56eb88b47599", "name": "Forbidden", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d6c8ad73-370f-4f64-b35e-56eb88b47599" }, { "id": "8d067839-2e57-4479-b5a1-1ee43e6ea477", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8d067839-2e57-4479-b5a1-1ee43e6ea477" }, { "id": "64df86ea-25a3-4205-8ac2-d7fa5576b80e", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-64df86ea-25a3-4205-8ac2-d7fa5576b80e" }, { "id": "9bf5d032-7f92-4b72-b508-ff2f051c760b", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9bf5d032-7f92-4b72-b508-ff2f051c760b" }, { "id": "5a61c7fc-a486-4d68-972b-fa5c07e398db", "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 \"billing_address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/billing-address-details?billing_address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "billing-address-details" ], "query": [ { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5a61c7fc-a486-4d68-972b-fa5c07e398db" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9b086a7a-d2ae-43c7-abc9-88bc79043b4f" } ], "id": "a827d53b-996b-4a88-b458-af05717e1169", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a827d53b-996b-4a88-b458-af05717e1169" }, { "name": "administrative-details", "item": [ { "name": "Update administrative details", "id": "c324d69b-eac6-4d22-a6b9-d6a9f2feb00a", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "variable": [ { "id": "8b7c2fc3-d10c-4817-99c6-576d02ff6bc9", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's administrative details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "ef5bd107-4a05-4933-834f-6d5ce795796b", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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 \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ef5bd107-4a05-4933-834f-6d5ce795796b" }, { "id": "ecd96ab7-a533-43cf-9259-9e911a2e5a1e", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ecd96ab7-a533-43cf-9259-9e911a2e5a1e" }, { "id": "cccdb64e-f22c-4722-ae6f-abb4bd12baad", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cccdb64e-f22c-4722-ae6f-abb4bd12baad" }, { "id": "78044200-e13e-4d45-9b2d-7ea25321df38", "name": "Forbidden", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-78044200-e13e-4d45-9b2d-7ea25321df38" }, { "id": "b9d8a34f-fe66-4306-9742-5ce5cd587b28", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b9d8a34f-fe66-4306-9742-5ce5cd587b28" }, { "id": "0f01cfd9-b744-4edd-b859-f1c17d7c8264", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0f01cfd9-b744-4edd-b859-f1c17d7c8264" }, { "id": "b57e5148-efe6-4ee1-836e-b2efbde9f4d3", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b57e5148-efe6-4ee1-836e-b2efbde9f4d3" }, { "id": "68010b4a-2f44-485b-999f-cba87944cde3", "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 \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id", "administrative-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-68010b4a-2f44-485b-999f-cba87944cde3" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c324d69b-eac6-4d22-a6b9-d6a9f2feb00a" } ], "id": "a3718e74-13c7-4e1a-9f22-fe39ccbe4ccb", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a3718e74-13c7-4e1a-9f22-fe39ccbe4ccb" }, { "name": "Update employment", "id": "ad61c3c9-5e33-4444-9211-c368166f1a7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "id": "b798a33d-ec30-4311-9c7d-8cb23bdb950a", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] } }, "response": [ { "id": "1e3cc8f1-a9e8-4e88-832d-68db45438c3e", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1e3cc8f1-a9e8-4e88-832d-68db45438c3e" }, { "id": "386725a9-1bff-484b-b0d3-e605bccdc503", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-386725a9-1bff-484b-b0d3-e605bccdc503" }, { "id": "2639b271-91c0-4f91-885e-b436bc41b24e", "name": "Forbidden", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2639b271-91c0-4f91-885e-b436bc41b24e" }, { "id": "86726a9d-92ee-410b-919c-1950acc6fdbb", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-86726a9d-92ee-410b-919c-1950acc6fdbb" }, { "id": "14241fbd-24d4-4ff7-9088-01616a95010f", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-14241fbd-24d4-4ff7-9088-01616a95010f" }, { "id": "cbd5f95e-5ccd-4c01-91c5-05e2c7384d3c", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cbd5f95e-5ccd-4c01-91c5-05e2c7384d3c" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ad61c3c9-5e33-4444-9211-c368166f1a7a" }, { "name": "Update employment", "id": "b5de084d-2fdd-452d-a334-a53ef67bf96c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "id": "7e347439-2214-415d-ad63-feeb4b8f3681", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] } }, "response": [ { "id": "324d6bf9-542d-440a-bf35-90a69ef705e3", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-324d6bf9-542d-440a-bf35-90a69ef705e3" }, { "id": "56bd1519-5930-4779-993e-e25c1dd53ab4", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-56bd1519-5930-4779-993e-e25c1dd53ab4" }, { "id": "cf850222-8cb9-4533-b21d-d67bc3236622", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cf850222-8cb9-4533-b21d-d67bc3236622" }, { "id": "f5d34c3f-c7b1-440b-9b27-6fd39992227d", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f5d34c3f-c7b1-440b-9b27-6fd39992227d" }, { "id": "2fbbe1bd-da82-415e-a904-685ca6b06bfb", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2fbbe1bd-da82-415e-a904-685ca6b06bfb" }, { "id": "af52422e-5783-4b5b-bec3-ac3ed292dfa6", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-af52422e-5783-4b5b-bec3-ac3ed292dfa6" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b5de084d-2fdd-452d-a334-a53ef67bf96c" } ], "id": "f3e95985-ad7e-42a9-a313-8649687ab61d", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f3e95985-ad7e-42a9-a313-8649687ab61d" } ], "id": "cd80d218-6b9a-465f-a9ee-d9130e26409c", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cd80d218-6b9a-465f-a9ee-d9130e26409c" } ], "id": "18dec041-7ec3-408d-915c-384e79a65263", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-18dec041-7ec3-408d-915c-384e79a65263" }, { "name": "v1", "item": [ { "name": "cancel-onboarding", "item": [ { "name": "{employment_id}", "item": [ { "name": "Cancel onboarding", "id": "8291e9be-aa3a-4485-91e9-fd164bf1ebdd", "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/cancel-onboarding/:employment_id?async=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cancel-onboarding", ":employment_id" ], "query": [ { "description": "Whether the request should be performed async\n", "key": "async", "value": "" } ], "variable": [ { "id": "84425c70-f2b1-436e-a30b-bfaaad064e06", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Cancel onboarding.\n\nRequirements for the cancellation to succeed:\n\n* Employment has to be in `invited`, `created`, `created_awaiting_reserve`, `created_reserve_paid`, `pre_hire` status\n* Employee must not have signed the employment contract\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage onboarding (`onboarding:write`) |\n" }, "response": [ { "id": "5ed41509-e7df-4a67-829d-7045dfcaaa78", "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/cancel-onboarding/:employment_id?async=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cancel-onboarding", ":employment_id" ], "query": [ { "description": "Whether the request should be performed async\n", "key": "async", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5ed41509-e7df-4a67-829d-7045dfcaaa78" }, { "id": "83b0b5e5-d35a-46c6-a6b2-2dbccdaa947c", "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/cancel-onboarding/:employment_id?async=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cancel-onboarding", ":employment_id" ], "query": [ { "description": "Whether the request should be performed async\n", "key": "async", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-83b0b5e5-d35a-46c6-a6b2-2dbccdaa947c" }, { "id": "7a245e99-037b-4830-9c87-c10835b55dc0", "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/cancel-onboarding/:employment_id?async=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cancel-onboarding", ":employment_id" ], "query": [ { "description": "Whether the request should be performed async\n", "key": "async", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7a245e99-037b-4830-9c87-c10835b55dc0" }, { "id": "91e787ce-e11c-4218-bb6a-f39f7a5d4450", "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/cancel-onboarding/:employment_id?async=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cancel-onboarding", ":employment_id" ], "query": [ { "description": "Whether the request should be performed async\n", "key": "async", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-91e787ce-e11c-4218-bb6a-f39f7a5d4450" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8291e9be-aa3a-4485-91e9-fd164bf1ebdd" } ], "id": "60051afe-fca3-4b91-8729-c4c649443525", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-60051afe-fca3-4b91-8729-c4c649443525" } ], "id": "c13010d1-b32f-4396-811e-998c65de64ac", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c13010d1-b32f-4396-811e-998c65de64ac" }, { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "job", "item": [ { "name": "Show employment job", "id": "77d0fcab-2557-4194-9377-f3c315db67da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/job", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "job" ], "variable": [ { "id": "fcdd81e3-eb95-4735-82b4-546f4d4cd82c", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Shows an employment job details.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "a3ec8e61-df87-4d5c-96b8-7044218d3bb5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/job", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "job" ], "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 \"id\": \"\",\n \"identifier\": \"\",\n \"label\": \"\",\n \"career_track\": {\n \"id\": \"\",\n \"label\": \"\"\n },\n \"code\": \"\",\n \"custom_field_values\": [\n {\n \"definition\": {\n \"id\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"definition\": {\n \"id\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"description\": \"\",\n \"job_family\": {\n \"id\": \"\",\n \"label\": \"\"\n },\n \"job_level\": {\n \"id\": \"\",\n \"label\": \"\"\n },\n \"job_sub_family\": {\n \"id\": \"\",\n \"label\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a3ec8e61-df87-4d5c-96b8-7044218d3bb5" }, { "id": "fe801927-4a3d-4531-943b-8588f02c0b0c", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/job", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "job" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fe801927-4a3d-4531-943b-8588f02c0b0c" }, { "id": "2259d11b-99d3-46d9-9256-5daf908913e0", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/job", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "job" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2259d11b-99d3-46d9-9256-5daf908913e0" }, { "id": "ae180489-8844-4b05-af0a-7d51829d9f2b", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/job", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "job" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ae180489-8844-4b05-af0a-7d51829d9f2b" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-77d0fcab-2557-4194-9377-f3c315db67da" } ], "id": "88bd61ae-2ff7-4195-98e7-edf94ebc6c59", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-88bd61ae-2ff7-4195-98e7-edf94ebc6c59" }, { "name": "background-checks", "item": [ { "name": "{background_check_id}", "item": [ { "name": "Show Background Check", "id": "45528ed1-0be2-4f25-9728-bdecf32367b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/background-checks/:background_check_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "background-checks", ":background_check_id" ], "variable": [ { "id": "c377d11a-cd16-4ea7-9bb9-75d3fa549ab4", "key": "employment_id", "value": "", "description": "(Required) Employment Id" }, { "id": "3337ee98-4a21-4920-a54c-430d480ff346", "key": "background_check_id", "value": "", "description": "(Required) Background Check Id" } ] }, "description": "Show Background Check details for a given employment and background check request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View background checks (`background_check:read`) | - |\n" }, "response": [ { "id": "82644873-139f-4a21-a728-87edcd428c33", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/background-checks/:background_check_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "background-checks", ":background_check_id" ], "variable": [ { "key": "employment_id" }, { "key": "background_check_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"background_check\": {\n \"id\": \"\",\n \"status\": \"employer_requested\",\n \"employment_id\": \"\",\n \"created_at\": \"\",\n \"background_check_request_items\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"canceled\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"needs_employer_review\",\n \"title\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-82644873-139f-4a21-a728-87edcd428c33" }, { "id": "a2dcb380-574c-4f20-882f-19bb1bfb0f56", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/background-checks/:background_check_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "background-checks", ":background_check_id" ], "variable": [ { "key": "employment_id" }, { "key": "background_check_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a2dcb380-574c-4f20-882f-19bb1bfb0f56" }, { "id": "27d58c6f-a2c0-4b1b-8c57-f9a126a6abe1", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/background-checks/:background_check_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "background-checks", ":background_check_id" ], "variable": [ { "key": "employment_id" }, { "key": "background_check_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-27d58c6f-a2c0-4b1b-8c57-f9a126a6abe1" }, { "id": "ef1c76a5-6001-4372-9d3c-3376e437be74", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/background-checks/:background_check_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "background-checks", ":background_check_id" ], "variable": [ { "key": "employment_id" }, { "key": "background_check_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ef1c76a5-6001-4372-9d3c-3376e437be74" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-45528ed1-0be2-4f25-9728-bdecf32367b0" } ], "id": "3bee8f40-c57b-4211-b814-faaec5229cd1", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3bee8f40-c57b-4211-b814-faaec5229cd1" } ], "id": "39d9fe78-6be9-41ec-8bb1-36324b3044ca", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-39d9fe78-6be9-41ec-8bb1-36324b3044ca" }, { "name": "cost-center-allocations", "item": [ { "name": "List cost center allocations for an employment", "id": "20ce97b2-7785-49e0-b96c-d9b4a0d80836", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "variable": [ { "id": "46b8f7e0-556f-4fa8-b801-035e9b5b94c6", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Lists the cost center allocations for an employment. Each allocation includes the cost center,\nthe allocated percentage, and its effective period. An employment with no cost center assigned\nreturns an empty list.\n\nUse the `status` query parameter to return only `active`, `scheduled`, or `expired` allocations.\nWhen omitted, all allocations are returned.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "1893bf37-fd1d-47f2-a570-03c03146f50b", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "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 \"cost_center_allocations\": [\n {\n \"id\": \"\",\n \"cost_center\": {\n \"name\": \"\",\n \"code\": \"\",\n \"slug\": \"\"\n },\n \"percentage\": \"\",\n \"effective_from\": \"\",\n \"effective_to\": \"\",\n \"status\": \"scheduled\"\n },\n {\n \"id\": \"\",\n \"cost_center\": {\n \"name\": \"\",\n \"code\": \"\",\n \"slug\": \"\"\n },\n \"percentage\": \"\",\n \"effective_from\": \"\",\n \"effective_to\": \"\",\n \"status\": \"expired\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1893bf37-fd1d-47f2-a570-03c03146f50b" }, { "id": "328ba02e-bbd7-4abf-8f4b-bbbfef783943", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-328ba02e-bbd7-4abf-8f4b-bbbfef783943" }, { "id": "425fcc17-eb3a-48ee-a38a-7d53515695f6", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-425fcc17-eb3a-48ee-a38a-7d53515695f6" }, { "id": "8318f3a0-c82b-495b-a54d-e617f278fb3f", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8318f3a0-c82b-495b-a54d-e617f278fb3f" }, { "id": "2f017385-fd02-4cc3-96c3-2ecc5ee9c691", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2f017385-fd02-4cc3-96c3-2ecc5ee9c691" }, { "id": "fded3c78-ec3e-4b51-ab57-347e1b352971", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/cost-center-allocations?status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fded3c78-ec3e-4b51-ab57-347e1b352971" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-20ce97b2-7785-49e0-b96c-d9b4a0d80836" } ], "id": "4d7c492f-7e65-4c06-b9a4-860fb8aca116", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4d7c492f-7e65-4c06-b9a4-860fb8aca116" }, { "name": "risk-reserve-proof-of-payments", "item": [ { "name": "Submit risk reserve proof of payment", "id": "c97c3cb7-4e08-421f-97b0-c7e69ab42e63", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The proof of payment file (PDF)", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/risk-reserve-proof-of-payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "risk-reserve-proof-of-payments" ], "variable": [ { "id": "79b71f57-ea5c-4c50-a907-51514ab696ee", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Submits a proof of payment document for a risk reserve associated with an employment.\n\nTriggers an `employment.cor_hiring.proof_of_payment_submitted` webhook event.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) |\n" }, "response": [ { "id": "dcd09a23-70dc-48e7-9d3e-3a8afede418a", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The proof of payment file (PDF)", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/risk-reserve-proof-of-payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "risk-reserve-proof-of-payments" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-dcd09a23-70dc-48e7-9d3e-3a8afede418a" }, { "id": "8801f808-4b0f-4a47-aaaf-a58e3b7a2310", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The proof of payment file (PDF)", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/risk-reserve-proof-of-payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "risk-reserve-proof-of-payments" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8801f808-4b0f-4a47-aaaf-a58e3b7a2310" }, { "id": "dcb31484-6674-4714-883a-a1905e3b3286", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The proof of payment file (PDF)", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/risk-reserve-proof-of-payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "risk-reserve-proof-of-payments" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-dcb31484-6674-4714-883a-a1905e3b3286" }, { "id": "0c4b5254-abd6-42bf-bbd7-1a8b6c8d56f8", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The proof of payment file (PDF)", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/risk-reserve-proof-of-payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "risk-reserve-proof-of-payments" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0c4b5254-abd6-42bf-bbd7-1a8b6c8d56f8" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c97c3cb7-4e08-421f-97b0-c7e69ab42e63" } ], "id": "cf56971a-95b6-4dba-aef8-b4380757d0a1", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cf56971a-95b6-4dba-aef8-b4380757d0a1" }, { "name": "federal-taxes", "item": [ { "name": "Update federal taxes", "id": "0010aad1-69af-4d8c-9b07-5493c24fd4d7", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "variable": [ { "id": "f930ecab-0b8f-48b1-b858-d143538da111", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's federal taxes.\n\nRequirements to update federal taxes successfully:\n* Employment should be Global Payroll\n* Employment should be in the post-enrollment state\n* Employment should belong to USA\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "7b035198-9708-4691-9553-312391951784", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7b035198-9708-4691-9553-312391951784" }, { "id": "64feed21-0b0f-4da1-9669-d01b46197767", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-64feed21-0b0f-4da1-9669-d01b46197767" }, { "id": "feb19c2e-8095-4968-81ed-af0a6d9acbf6", "name": "Forbidden", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-feb19c2e-8095-4968-81ed-af0a6d9acbf6" }, { "id": "879a5293-4f27-4efa-a96c-2fdee9d4130f", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-879a5293-4f27-4efa-a96c-2fdee9d4130f" }, { "id": "70f56c77-b976-4af1-b64e-d23075a01cf8", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-70f56c77-b976-4af1-b64e-d23075a01cf8" }, { "id": "713ca6db-ec19-43cd-9ee6-4e0e25981885", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-713ca6db-ec19-43cd-9ee6-4e0e25981885" }, { "id": "05ffef19-93a5-4223-8938-88c2f772d411", "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 \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "federal-taxes" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-05ffef19-93a5-4223-8938-88c2f772d411" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0010aad1-69af-4d8c-9b07-5493c24fd4d7" } ], "id": "32623683-462c-458d-b66a-63f21996e6a2", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-32623683-462c-458d-b66a-63f21996e6a2" }, { "name": "basic-information", "item": [ { "name": "Update basic information", "id": "17bbaf66-5f19-4449-8fad-590d7310edc7", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "variable": [ { "id": "d270481e-65bd-4d39-be55-29e01ea27822", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's basic information.\n\nSupported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "ef5356c2-ba9d-4f05-92cc-270eb0b77c89", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ef5356c2-ba9d-4f05-92cc-270eb0b77c89" }, { "id": "e5047b9a-8dfd-477e-b739-282b9fb4554d", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e5047b9a-8dfd-477e-b739-282b9fb4554d" }, { "id": "9d870395-132c-4852-a304-1e2b9dee1256", "name": "Forbidden", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9d870395-132c-4852-a304-1e2b9dee1256" }, { "id": "ac7bc39f-ffe3-4808-9085-d15193be1640", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ac7bc39f-ffe3-4808-9085-d15193be1640" }, { "id": "9a5ea350-2bed-4215-b11f-b9aaae8547e9", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9a5ea350-2bed-4215-b11f-b9aaae8547e9" }, { "id": "0bd6530b-0dd5-4f08-95c7-b227caf75d33", "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 \"basic_information\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/basic-information", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "basic-information" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0bd6530b-0dd5-4f08-95c7-b227caf75d33" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-17bbaf66-5f19-4449-8fad-590d7310edc7" } ], "id": "0e4c5d82-d21f-4a92-8bf4-f064fc98f862", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0e4c5d82-d21f-4a92-8bf4-f064fc98f862" }, { "name": "contract-origin", "item": [ { "name": "Set contract origin for a contractor employment", "id": "f78ad8ee-b081-453d-b718-296d8d9b0469", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement_v2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "variable": [ { "id": "1870cb28-07b6-4db5-b68f-d5e15a77f510", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Sets the `contract_origin` for a contractor employment.\n\n* `remote_contract` \u2014 Remote provides and manages the contract (a contract document is created)\n* `custom_remote_contract` \u2014 A customised Remote contract is used (a contract document is created)\n* `provided_by_customer` \u2014 The employer provides their own contract (no contract document is created)\n\nWhen `provided_by_customer` is selected, the contractor can be invited without completing the\n`contract_details` onboarding step.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "c762afe0-98df-4b0c-b3d5-d6094e714947", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement_v2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c762afe0-98df-4b0c-b3d5-d6094e714947" }, { "id": "98a0e433-ff91-4f07-a33e-96de90b5daa2", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement_v2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-98a0e433-ff91-4f07-a33e-96de90b5daa2" }, { "id": "d4ec3bad-729e-4bd3-8911-98371d088aad", "name": "Conflict", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement_v2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d4ec3bad-729e-4bd3-8911-98371d088aad" }, { "id": "97ff4f4c-3ad2-457e-b6b1-9f22a9ffdc31", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement_v2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-97ff4f4c-3ad2-457e-b6b1-9f22a9ffdc31" }, { "id": "7f983abc-ec50-4fa6-9cde-4eb0dc553d58", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement_v2\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7f983abc-ec50-4fa6-9cde-4eb0dc553d58" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f78ad8ee-b081-453d-b718-296d8d9b0469" } ], "id": "5f022593-b5ef-4be0-afbb-feb346172fda", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5f022593-b5ef-4be0-afbb-feb346172fda" }, { "name": "files", "item": [ { "name": "List employment files", "id": "38dd87d5-f116-4dc7-a773-83ba7070a1a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/files?type=&sub_type=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "files" ], "query": [ { "description": "Filter by file type (optional)", "key": "type", "value": "" }, { "description": "Filter by file sub_type (optional)", "key": "sub_type", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "84f00705-d236-4aa6-b3c3-9e062b69eec0", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Lists files associated with a specific employment.\n\nSupports filtering by file type and sub_type.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "9ebda333-ed2b-40f3-b430-6d6ad40d1fda", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/files?type=&sub_type=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "files" ], "query": [ { "description": "Filter by file type (optional)", "key": "type", "value": "" }, { "description": "Filter by file sub_type (optional)", "key": "sub_type", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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 \"current_page\": \"\",\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 \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9ebda333-ed2b-40f3-b430-6d6ad40d1fda" }, { "id": "e853238d-7d16-4a64-a012-ef35fef0b331", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/files?type=&sub_type=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "files" ], "query": [ { "description": "Filter by file type (optional)", "key": "type", "value": "" }, { "description": "Filter by file sub_type (optional)", "key": "sub_type", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e853238d-7d16-4a64-a012-ef35fef0b331" }, { "id": "b6f456ec-9324-4f53-b503-71f62fc53ae8", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/files?type=&sub_type=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "files" ], "query": [ { "description": "Filter by file type (optional)", "key": "type", "value": "" }, { "description": "Filter by file sub_type (optional)", "key": "sub_type", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b6f456ec-9324-4f53-b503-71f62fc53ae8" }, { "id": "0a356c7e-d85d-45f2-8cc3-aa335800f330", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/files?type=&sub_type=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "files" ], "query": [ { "description": "Filter by file type (optional)", "key": "type", "value": "" }, { "description": "Filter by file sub_type (optional)", "key": "sub_type", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0a356c7e-d85d-45f2-8cc3-aa335800f330" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-38dd87d5-f116-4dc7-a773-83ba7070a1a9" } ], "id": "1adbfd86-bbfd-4259-8426-cca24ba64d66", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1adbfd86-bbfd-4259-8426-cca24ba64d66" }, { "name": "invite", "item": [ { "name": "Invite employment", "id": "65422fea-59d3-46b5-a8c1-d36bc3eeeffa", "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/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "variable": [ { "id": "2758a245-8167-44f7-9c76-cc4c2b1335a5", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Invite an employment to start the self-enrollment.\n\nRequirements for the invitation to succeed:\n\n* Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details`\n* `provisional_start_date` must consider the minimum onboarding time of the employment's country\n\nIf there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message.\nHTTP Status OK (200) is returned in case of success.\n\nIn case of the following error message:\n`\"Please reselect benefits - the previous selection is no longer available\"`\nit means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema.\n\nIn this case, reselect benefits by updating `contract_details` JSON Schema form.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "f6cd1ee7-046c-4ec0-aa31-0b07c461d723", "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/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f6cd1ee7-046c-4ec0-aa31-0b07c461d723" }, { "id": "9b092e2b-5636-4dc0-b15a-69416dc6eb94", "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/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9b092e2b-5636-4dc0-b15a-69416dc6eb94" }, { "id": "7e6582fd-0411-43df-b471-eaa9d8d00a06", "name": "Conflict", "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/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7e6582fd-0411-43df-b471-eaa9d8d00a06" }, { "id": "67332ffe-65bb-408e-ac7a-b89d0894b567", "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/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-67332ffe-65bb-408e-ac7a-b89d0894b567" }, { "id": "d31dde4e-3d81-41cb-aadc-8fbcae73e428", "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/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d31dde4e-3d81-41cb-aadc-8fbcae73e428" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-65422fea-59d3-46b5-a8c1-d36bc3eeeffa" } ], "id": "263bee37-9e11-4712-8642-3dba9ce939f9", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-263bee37-9e11-4712-8642-3dba9ce939f9" }, { "name": "onboarding-steps", "item": [ { "name": "Show onboarding steps for an employment", "id": "46a8fd6f-9de9-44f9-be09-438de7d6aa8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/onboarding-steps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "onboarding-steps" ], "variable": [ { "id": "13bb3d54-ba4f-4302-b8af-45e3d3b68130", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns onboarding steps and substeps in a hierarchical, ordered structure.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "30b182be-ca7b-4531-b48e-8cc86f5b24d5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/onboarding-steps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "onboarding-steps" ], "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 \"steps\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"status\": \"in_progress\",\n \"sub_steps\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"status\": \"in_progress\",\n \"optional\": \"\",\n \"completed_at\": \"\",\n \"started_at\": \"\",\n \"tag\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"status\": \"not_started\",\n \"optional\": \"\",\n \"completed_at\": \"\",\n \"started_at\": \"\",\n \"tag\": \"\"\n }\n ],\n \"completed_at\": \"\",\n \"description\": \"\",\n \"started_at\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"status\": \"not_started\",\n \"sub_steps\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"status\": \"completed\",\n \"optional\": \"\",\n \"completed_at\": \"\",\n \"started_at\": \"\",\n \"tag\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"status\": \"not_started\",\n \"optional\": \"\",\n \"completed_at\": \"\",\n \"started_at\": \"\",\n \"tag\": \"\"\n }\n ],\n \"completed_at\": \"\",\n \"description\": \"\",\n \"started_at\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-30b182be-ca7b-4531-b48e-8cc86f5b24d5" }, { "id": "a7ca91d7-5f81-4ba8-9031-2e0b1311b956", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/onboarding-steps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "onboarding-steps" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a7ca91d7-5f81-4ba8-9031-2e0b1311b956" }, { "id": "c34221e0-12a1-4a74-ac5e-6fc27cbafed4", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/onboarding-steps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "onboarding-steps" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c34221e0-12a1-4a74-ac5e-6fc27cbafed4" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-46a8fd6f-9de9-44f9-be09-438de7d6aa8b" } ], "id": "c22a04cf-ddde-4da1-8a8b-09a5022079da", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c22a04cf-ddde-4da1-8a8b-09a5022079da" }, { "name": "personal-details", "item": [ { "name": "Update personal details", "id": "a5327eee-02df-4d19-98b0-3c2b7a27049b", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "variable": [ { "id": "fb768fa2-adeb-4806-855e-ced08988cc1d", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates employment's personal details.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "1c60ef83-9efe-431b-b536-4767628bded6", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1c60ef83-9efe-431b-b536-4767628bded6" }, { "id": "439fddd2-5571-4b39-9a41-af7c86360b51", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-439fddd2-5571-4b39-9a41-af7c86360b51" }, { "id": "13aa3176-dbe6-4b5c-80f6-58f1f9e8a470", "name": "Forbidden", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-13aa3176-dbe6-4b5c-80f6-58f1f9e8a470" }, { "id": "ace28ec7-c41f-4d1c-aa84-00cd32cd6215", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ace28ec7-c41f-4d1c-aa84-00cd32cd6215" }, { "id": "add057e2-07fe-4242-828d-a302a88bcaf6", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-add057e2-07fe-4242-828d-a302a88bcaf6" }, { "id": "6d4a70b4-3d09-4a13-a747-cbfeecd02684", "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 \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/personal-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "personal-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6d4a70b4-3d09-4a13-a747-cbfeecd02684" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a5327eee-02df-4d19-98b0-3c2b7a27049b" } ], "id": "023d19bd-282f-48af-ae73-fcfeeda6ebbe", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-023d19bd-282f-48af-ae73-fcfeeda6ebbe" }, { "name": "engagement-agreement-details", "item": [ { "name": "Get engagement agreement details", "id": "e68054fd-1fff-4ae3-b11d-4dfb64515379", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "id": "9ef15c3e-c97f-4daa-8d15-ecc47bd08ef0", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the engagement agreement details for an employment.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "88e54965-71ab-496f-ad9a-59267008436d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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 \"details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-88e54965-71ab-496f-ad9a-59267008436d" }, { "id": "6c1a7653-e80f-4971-ac4d-cee812bb28c2", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6c1a7653-e80f-4971-ac4d-cee812bb28c2" }, { "id": "6fa285c6-211b-455d-b9ca-fd5570253a72", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6fa285c6-211b-455d-b9ca-fd5570253a72" }, { "id": "a9a5ed55-cad5-4c23-9332-555ed7beb4ab", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a9a5ed55-cad5-4c23-9332-555ed7beb4ab" }, { "id": "505a6a31-fb1d-4ac5-830e-925377551fd2", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-505a6a31-fb1d-4ac5-830e-925377551fd2" }, { "id": "70916ee8-0cc3-4450-9759-bb2388c1fb54", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-70916ee8-0cc3-4450-9759-bb2388c1fb54" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e68054fd-1fff-4ae3-b11d-4dfb64515379" }, { "name": "Upsert engagement agreement details", "id": "e1e7a52e-203d-4eed-8a6e-1a05d486f915", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "id": "3698791c-76dc-4320-a0be-d2e5974c85a5", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Creates or updates the engagement agreement details for an employment.\n\nThis endpoint requires country-specific data. The exact required fields will vary depending on\nwhich country the employment is in. To see the list of parameters for each country, see the\n**Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that compliance requirements for each country are subject to change according to local laws.\nUsing Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended\nto avoid compliance issues and to have the latest version of a country's requirements.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "89bdacdd-6acb-4268-9561-717ec6368d88", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-89bdacdd-6acb-4268-9561-717ec6368d88" }, { "id": "e9c5883d-7912-4a02-a829-75baa5e44c60", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e9c5883d-7912-4a02-a829-75baa5e44c60" }, { "id": "5c950fad-5e23-488e-b643-78609f18973b", "name": "Forbidden", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5c950fad-5e23-488e-b643-78609f18973b" }, { "id": "40124c52-e24c-46e6-9512-ff6d3717cc56", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-40124c52-e24c-46e6-9512-ff6d3717cc56" }, { "id": "3e108414-229b-4ed1-b1a9-8715087ed9f9", "name": "Conflict", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3e108414-229b-4ed1-b1a9-8715087ed9f9" }, { "id": "aa2840f0-7226-4bf0-9d24-a6e4e63f182f", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-aa2840f0-7226-4bf0-9d24-a6e4e63f182f" }, { "id": "647ebbb4-1cb5-4cd3-9b61-fb57d4d3f892", "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 \"engagement_agreement_details\": {\n \"allowances_details\": [\n \"\",\n \"\"\n ],\n \"available_pto\": \"\",\n \"break_time_per_day\": \"\",\n \"business_expenses\": \"\",\n \"cba\": \"\",\n \"cba_document\": {},\n \"covenants\": [\n \"\",\n \"\"\n ],\n \"has_allowances\": \"\",\n \"has_bonus\": \"\",\n \"has_business_expenses\": \"\",\n \"has_business_presence\": \"\",\n \"has_cba\": \"\",\n \"has_commissions\": \"\",\n \"has_covenants\": \"\",\n \"has_illness_remuneration\": \"\",\n \"has_overtime_compensation\": \"\",\n \"has_pension_scheme\": \"\",\n \"has_signing_bonus\": \"\",\n \"has_similar_roles\": \"\",\n \"has_similar_work_conditions\": \"\",\n \"illness_remuneration_details\": \"\",\n \"max_annual_gross_salary\": \"\",\n \"min_annual_gross_salary\": \"\",\n \"overtime_compensation_begins\": \"\",\n \"overtime_compensation_type\": \"\",\n \"overtime_pay_percentage\": \"\",\n \"pension_scheme\": \"\",\n \"similar_roles\": \"\",\n \"similar_work_conditions_details\": \"\",\n \"work_hours_per_week\": \"\",\n \"working_days\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "engagement-agreement-details" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-647ebbb4-1cb5-4cd3-9b61-fb57d4d3f892" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e1e7a52e-203d-4eed-8a6e-1a05d486f915" } ], "id": "f0bde660-7af8-43be-872e-4cc6faf6e95d", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f0bde660-7af8-43be-872e-4cc6faf6e95d" }, { "name": "Show employment", "id": "d9c9ec2f-0547-423c-86fb-8ad3fdf1a26a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "variable": [ { "id": "cdc28606-2dc9-4b4d-94a9-73277f859347", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Shows all the information of an employment.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "4fec31cc-ff13-43ab-a3d5-ec0d851fd57e", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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\": \"global_payroll_employee\",\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\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"active\",\n \"employment_lifecycle_stage\": \"remote_enrollment\",\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\": \"plus\",\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\": \"deleted\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"termination_date\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4fec31cc-ff13-43ab-a3d5-ec0d851fd57e" }, { "id": "b5d1f78f-c3dc-436a-92b0-f6ead2760cea", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b5d1f78f-c3dc-436a-92b0-f6ead2760cea" }, { "id": "86a49dc6-c935-417d-9d55-1c4ca76bb0db", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-86a49dc6-c935-417d-9d55-1c4ca76bb0db" }, { "id": "2e57792b-de83-472b-8a2b-588754ea31a4", "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2e57792b-de83-472b-8a2b-588754ea31a4" }, { "id": "9a69940e-4866-44f1-b745-b29cbcbce586", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9a69940e-4866-44f1-b745-b29cbcbce586" }, { "id": "f017085c-ed38-41c9-8656-00fe66e948b4", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f017085c-ed38-41c9-8656-00fe66e948b4" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d9c9ec2f-0547-423c-86fb-8ad3fdf1a26a" }, { "name": "Update employment", "id": "6c785b22-089a-4511-915b-a043f3247620", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "id": "14649d35-1469-4152-93ec-b8c6683a3cc8", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates an employment.\n\n**For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information.\n\n**For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email.\n\n**For `invited` employments:** You can update the work_email.\n\nAfter onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`.\nIf you want to provide additional information for an employment, please make sure to do so **before** the employee is invited.\nWe block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details.\nCurrently, these amendments can only be done through the Remote UI.\n\nIt is possible to update the `external_id` of the employment for all employment statuses.\n\n## Global Payroll Employees\n\nTo update a Global Payment employment your input data must comply with the global payroll json schemas.\n\n**For `active` employments:** In addition to the above list, you can update personal_details.\n\n## Direct Employees\n\nTo update an HRIS employment your input data must comply with the HRIS json schemas.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\nPlease contact Remote if you need to update contractors via API since it's currently not supported.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "bd057dc5-cc14-4b6a-8a97-e7d16e6428b7", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bd057dc5-cc14-4b6a-8a97-e7d16e6428b7" }, { "id": "8cac9f31-e8eb-4efa-a9f0-f3a834bd4745", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8cac9f31-e8eb-4efa-a9f0-f3a834bd4745" }, { "id": "3ceb3bbd-f00d-479a-8cd8-63b038c52103", "name": "Forbidden", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3ceb3bbd-f00d-479a-8cd8-63b038c52103" }, { "id": "29a93fe0-415b-45f2-8904-65e9a8098f36", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-29a93fe0-415b-45f2-8904-65e9a8098f36" }, { "id": "03be4295-5080-4340-8f64-4206c5ec8296", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-03be4295-5080-4340-8f64-4206c5ec8296" }, { "id": "6421023e-3371-43f5-a42e-e2b4a80cf508", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6421023e-3371-43f5-a42e-e2b4a80cf508" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6c785b22-089a-4511-915b-a043f3247620" }, { "name": "Update employment", "id": "40e8770c-5514-4c6c-a3e6-334df7af27b6", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "id": "c2b7e2bc-57e6-4e29-a478-6853acf59258", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates an employment.\n\n**For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information.\n\n**For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email.\n\n**For `invited` employments:** You can update the work_email.\n\nAfter onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`.\nIf you want to provide additional information for an employment, please make sure to do so **before** the employee is invited.\nWe block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details.\nCurrently, these amendments can only be done through the Remote UI.\n\nIt is possible to update the `external_id` of the employment for all employment statuses.\n\n## Global Payroll Employees\n\nTo update a Global Payment employment your input data must comply with the global payroll json schemas.\n\n**For `active` employments:** In addition to the above list, you can update personal_details.\n\n## Direct Employees\n\nTo update an HRIS employment your input data must comply with the HRIS json schemas.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\nPlease contact Remote if you need to update contractors via API since it's currently not supported.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "ff5e7bf3-bab7-4163-b943-93976f38b436", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ff5e7bf3-bab7-4163-b943-93976f38b436" }, { "id": "77771cc0-6c75-4eec-ac00-a123e06b9f57", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-77771cc0-6c75-4eec-ac00-a123e06b9f57" }, { "id": "f069ba54-f7a0-4684-aff4-0f5965027e97", "name": "Forbidden", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f069ba54-f7a0-4684-aff4-0f5965027e97" }, { "id": "339a90f0-ac81-41a3-87c3-045d82d77bb2", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-339a90f0-ac81-41a3-87c3-045d82d77bb2" }, { "id": "4d27ac62-85c4-43d1-8964-1de4d79351ae", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4d27ac62-85c4-43d1-8964-1de4d79351ae" }, { "id": "3b973691-0113-45ce-8874-984464bbd2af", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\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 \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"contractor\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3b973691-0113-45ce-8874-984464bbd2af" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-40e8770c-5514-4c6c-a3e6-334df7af27b6" } ], "id": "968c364d-a17b-403e-b0b1-b49db1f094b3", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-968c364d-a17b-403e-b0b1-b49db1f094b3" }, { "name": "List employments", "id": "08dc572f-e279-488f-b00f-421e975b9520", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "Lists all employments, except for the deleted ones.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n" }, "response": [ { "id": "e971ecb2-a2c2-43da-b03f-dfbbf4b82389", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"employments\": [\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\n \"standard\"\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 \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"status\": \"invited\",\n \"type\": \"employee\",\n \"short_id\": \"\",\n \"external_id\": \"\",\n \"employment_lifecycle_stage\": \"employment_creation\",\n \"work_address_details\": {},\n \"employment_model\": \"eor\",\n \"work_email\": \"\",\n \"department\": \"\",\n \"department_id\": \"\"\n },\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\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 \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"status\": \"created\",\n \"type\": \"global_payroll_employee\",\n \"short_id\": \"\",\n \"external_id\": \"\",\n \"employment_lifecycle_stage\": \"remote_enrollment\",\n \"work_address_details\": {},\n \"employment_model\": \"eor\",\n \"work_email\": \"\",\n \"department\": \"\",\n \"department_id\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e971ecb2-a2c2-43da-b03f-dfbbf4b82389" }, { "id": "37d83f7a-12a2-448d-be77-e95a8e0e91a6", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-37d83f7a-12a2-448d-be77-e95a8e0e91a6" }, { "id": "372dbba2-d51b-4a79-9229-0a469e4623f0", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-372dbba2-d51b-4a79-9229-0a469e4623f0" }, { "id": "ce616c3c-bcfc-4716-bcb3-32c62035bece", "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ce616c3c-bcfc-4716-bcb3-32c62035bece" }, { "id": "8f6f5eb4-401a-4422-9ca8-70817b15b712", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8f6f5eb4-401a-4422-9ca8-70817b15b712" }, { "id": "3b43fd1c-e496-4e6b-9f1a-98eaa7dbb49f", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=global_payroll&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "global_payroll" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3b43fd1c-e496-4e6b-9f1a-98eaa7dbb49f" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-08dc572f-e279-488f-b00f-421e975b9520" }, { "name": "Create employment", "id": "aa4a1535-87f6-4978-bdf5-800de4a80a14", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Creates an employment. We support creating employees and contractors.\n\n## Global Payroll Employees\n\nTo create a Global Payroll employee, pass `global_payroll_employee` as the `type` parameter,\nand provide the id of the specific legal entity that the employee will be engaged by and billed to as the `engaged_by_legal_entity_id` parameter.\n\n## HRIS Employees\n\nTo create a HRIS employee, pass `hris` as the `type` parameter.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "ef854b40-05a1-49e8-837d-be94c89cf25f", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"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\": \"employee\",\n \"updated_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ef854b40-05a1-49e8-837d-be94c89cf25f" }, { "id": "7df9d6ce-6efd-4cae-8dc1-4e6dc886cc87", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7df9d6ce-6efd-4cae-8dc1-4e6dc886cc87" }, { "id": "be9f6ddb-a4ab-42b7-ab49-63f294ff56e6", "name": "Forbidden", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-be9f6ddb-a4ab-42b7-ab49-63f294ff56e6" }, { "id": "e542aaa0-b573-4e0e-b382-d879473d17aa", "name": "Conflict", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e542aaa0-b573-4e0e-b382-d879473d17aa" }, { "id": "d1e6aa82-5df6-4587-bd86-d38573ab59f3", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d1e6aa82-5df6-4587-bd86-d38573ab59f3" }, { "id": "bf598b7a-abac-4251-8523-c7e2ac6ddca8", "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/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bf598b7a-abac-4251-8523-c7e2ac6ddca8" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-aa4a1535-87f6-4978-bdf5-800de4a80a14" } ], "id": "e1ef9d3c-04c0-4429-a371-091510d4bb46", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e1ef9d3c-04c0-4429-a371-091510d4bb46" }, { "name": "employee", "item": [ { "name": "bank-account", "item": [ { "name": "Show employee bank account", "id": "f8ee1392-7838-48ab-978c-50f1e12311c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] }, "description": "Returns the authenticated employee's bank account details.\n\nThis endpoint requires and returns country-specific data. The exact fields vary depending on which\ncountry the authenticated employee's employment is in. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `bank_account_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View bank accounts (`bank_account:read`) | Manage bank accounts (`bank_account:write`) |\n" }, "response": [ { "id": "87d749fb-d6f1-4039-b4cd-0ffa28f5b15e", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-87d749fb-d6f1-4039-b4cd-0ffa28f5b15e" }, { "id": "c04262ec-cb40-44e5-a863-368cd68daabe", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c04262ec-cb40-44e5-a863-368cd68daabe" }, { "id": "f03e1ded-85e1-4afa-9ee0-cacf326fc0e9", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f03e1ded-85e1-4afa-9ee0-cacf326fc0e9" }, { "id": "5590b2e9-5c02-44db-b41a-9dd27be9f118", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5590b2e9-5c02-44db-b41a-9dd27be9f118" }, { "id": "e9770dfe-affa-40b3-be47-6bdb796a9c52", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e9770dfe-affa-40b3-be47-6bdb796a9c52" }, { "id": "7383f28e-a96b-4ba1-9276-6591e43142c4", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7383f28e-a96b-4ba1-9276-6591e43142c4" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f8ee1392-7838-48ab-978c-50f1e12311c9" }, { "name": "Update employee bank account", "id": "e37a6fa5-6f5e-4e93-9a58-c0b172e0bd7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] }, "description": "Upserts the authenticated employee's bank account details.\n\nThis endpoint requires and returns country-specific data. The exact fields vary depending on which\ncountry the authenticated employee's employment is in. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `bank_account_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage bank accounts (`bank_account:write`) |\n" }, "response": [ { "id": "fb32b9c5-46b1-4c03-a47d-17cdf387924f", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fb32b9c5-46b1-4c03-a47d-17cdf387924f" }, { "id": "f246f9dd-dc74-4417-bcc7-fd0c25b8ee26", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f246f9dd-dc74-4417-bcc7-fd0c25b8ee26" }, { "id": "6d4d5ae0-ec4f-4c3d-8bbb-fb2fa0e93007", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6d4d5ae0-ec4f-4c3d-8bbb-fb2fa0e93007" }, { "id": "a9ae27f0-644d-409f-8604-2bf98a2e1d3c", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a9ae27f0-644d-409f-8604-2bf98a2e1d3c" }, { "id": "44979143-c972-4473-a2ea-c448d29a88a1", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-44979143-c972-4473-a2ea-c448d29a88a1" }, { "id": "add165e3-5661-4297-8053-5f2b530303d6", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-add165e3-5661-4297-8053-5f2b530303d6" }, { "id": "898c9c54-0059-4367-b297-b0628d3f50a6", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"bank_account_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/bank-account?bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "bank-account" ], "query": [ { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-898c9c54-0059-4367-b297-b0628d3f50a6" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e37a6fa5-6f5e-4e93-9a58-c0b172e0bd7c" } ], "id": "98d613cb-2685-4df5-bcfc-1336bd6305b7", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-98d613cb-2685-4df5-bcfc-1336bd6305b7" }, { "name": "documents", "item": [ { "name": "{id}", "item": [ { "name": "Download a document for the employee", "id": "209171b9-a939-4342-882d-19fb23131297", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents", ":id" ], "variable": [ { "id": "057c965b-568e-4682-b30f-1646ca59bcb7", "key": "id", "value": "", "description": "(Required) Document ID" } ] }, "description": "## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "a7ce7474-6aa5-4530-893f-b2d8cab1bba0", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"document\": {\n \"content\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"sub_type\": \"\",\n \"type\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a7ce7474-6aa5-4530-893f-b2d8cab1bba0" }, { "id": "d996b559-a704-4c45-8303-d8c8e98b08c9", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents", ":id" ], "variable": [ { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d996b559-a704-4c45-8303-d8c8e98b08c9" }, { "id": "d22ebe65-44b1-4e06-8b4c-eaebdc9360d5", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents", ":id" ], "variable": [ { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d22ebe65-44b1-4e06-8b4c-eaebdc9360d5" }, { "id": "ab97564f-223d-406c-8b20-37cadd475c33", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents", ":id" ], "variable": [ { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ab97564f-223d-406c-8b20-37cadd475c33" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-209171b9-a939-4342-882d-19fb23131297" } ], "id": "ddcf43c0-247b-4e04-b7c2-4400c8c88c60", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ddcf43c0-247b-4e04-b7c2-4400c8c88c60" }, { "name": "Indexes all the documents for the employee", "id": "37150d4b-a3ad-473f-90f8-09e476709586", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents?page=1&page_size=20&name=&inserted_after=&inserted_before=&sort_by=inserted_at&order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" }, { "description": "Filter documents by their description or file name, accepts full and partial case insensitive matches", "key": "name", "value": "" }, { "description": "Filters the results that were uploaded on or after a given date", "key": "inserted_after", "value": "" }, { "description": "Filters the results that were uploaded before a given date", "key": "inserted_before", "value": "" }, { "description": "Field to sort by", "key": "sort_by", "value": "inserted_at" }, { "description": "Sort order", "key": "order", "value": "asc" } ] }, "description": "## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "47d84518-9f8a-40e6-9966-b13033d624f9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents?page=1&page_size=20&name=&inserted_after=&inserted_before=&sort_by=inserted_at&order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" }, { "description": "Filter documents by their description or file name, accepts full and partial case insensitive matches", "key": "name", "value": "" }, { "description": "Filters the results that were uploaded on or after a given date", "key": "inserted_after", "value": "" }, { "description": "Filters the results that were uploaded before a given date", "key": "inserted_before", "value": "" }, { "description": "Field to sort by", "key": "sort_by", "value": "inserted_at" }, { "description": "Sort order", "key": "order", "value": "asc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"documents\": [\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 \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-47d84518-9f8a-40e6-9966-b13033d624f9" }, { "id": "23bc32d9-1ef7-4921-851e-1b0783630bcb", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents?page=1&page_size=20&name=&inserted_after=&inserted_before=&sort_by=inserted_at&order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" }, { "description": "Filter documents by their description or file name, accepts full and partial case insensitive matches", "key": "name", "value": "" }, { "description": "Filters the results that were uploaded on or after a given date", "key": "inserted_after", "value": "" }, { "description": "Filters the results that were uploaded before a given date", "key": "inserted_before", "value": "" }, { "description": "Field to sort by", "key": "sort_by", "value": "inserted_at" }, { "description": "Sort order", "key": "order", "value": "asc" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-23bc32d9-1ef7-4921-851e-1b0783630bcb" }, { "id": "7cd90ed8-22a4-4798-95ae-95c9e360e034", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/documents?page=1&page_size=20&name=&inserted_after=&inserted_before=&sort_by=inserted_at&order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" }, { "description": "Filter documents by their description or file name, accepts full and partial case insensitive matches", "key": "name", "value": "" }, { "description": "Filters the results that were uploaded on or after a given date", "key": "inserted_after", "value": "" }, { "description": "Filters the results that were uploaded before a given date", "key": "inserted_before", "value": "" }, { "description": "Field to sort by", "key": "sort_by", "value": "inserted_at" }, { "description": "Sort order", "key": "order", "value": "asc" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7cd90ed8-22a4-4798-95ae-95c9e360e034" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-37150d4b-a3ad-473f-90f8-09e476709586" }, { "name": "Upload employee file", "id": "27606dcf-fd89-4530-aca0-b5d757be592a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file", "value": null }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] }, "description": "Uploads a file owned by the authenticated employee, for example\nidentity documents or tax forms.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "75a4ef68-0ef2-4009-863e-31d5db41b9a2", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"file\": {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-75a4ef68-0ef2-4009-863e-31d5db41b9a2" }, { "id": "3e24bd84-7a90-438a-9ac0-8d43ef8a9d4b", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3e24bd84-7a90-438a-9ac0-8d43ef8a9d4b" }, { "id": "fe62ba39-5e19-4fce-aac4-23dc09f6506c", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fe62ba39-5e19-4fce-aac4-23dc09f6506c" }, { "id": "bc8542b9-1b8c-427b-b34b-a2955aa9a6c0", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bc8542b9-1b8c-427b-b34b-a2955aa9a6c0" }, { "id": "c474643a-bae2-4a81-85c9-61f90e03c68e", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c474643a-bae2-4a81-85c9-61f90e03c68e" }, { "id": "0d5f2163-62c8-4fd4-92f4-b205a28a487c", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "A more specific classification within the type.", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/employee/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0d5f2163-62c8-4fd4-92f4-b205a28a487c" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-27606dcf-fd89-4530-aca0-b5d757be592a" } ], "id": "22ef59ab-8f00-4e01-a24c-a331f4392284", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-22ef59ab-8f00-4e01-a24c-a331f4392284" }, { "name": "address", "item": [ { "name": "Show employee address", "id": "b07eabf2-e9e8-46b1-9f27-005c17d8af7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] }, "description": "Returns the authenticated employee's residential address.\n\nThe employment is derived from the access token's subject \u2014 there is no\nemployment id in the path.\n\nThis endpoint requires country-specific data. The exact required fields vary depending on which\ncountry the authenticated employee's employment is in. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `address_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View addresses (`address:read`) | Manage addresses (`address:write`) |\n" }, "response": [ { "id": "d5b88afa-7bda-42fd-a0d7-f1986c697f04", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d5b88afa-7bda-42fd-a0d7-f1986c697f04" }, { "id": "708a43a0-c147-4ea2-b7a7-eb73deaa178c", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-708a43a0-c147-4ea2-b7a7-eb73deaa178c" }, { "id": "7db3d359-4885-43e5-a4ce-aba35c8e16a4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7db3d359-4885-43e5-a4ce-aba35c8e16a4" }, { "id": "59b2c20a-635a-416c-b310-ad7cac693a21", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-59b2c20a-635a-416c-b310-ad7cac693a21" }, { "id": "1167e43c-77f0-4a58-811d-309b5c9afcf7", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1167e43c-77f0-4a58-811d-309b5c9afcf7" }, { "id": "9f0f334b-5fea-4325-9efe-1cb6b7f179ee", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9f0f334b-5fea-4325-9efe-1cb6b7f179ee" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b07eabf2-e9e8-46b1-9f27-005c17d8af7a" }, { "name": "Update employee address", "id": "08931249-696a-4346-ad58-f128981b4730", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] }, "description": "Updates the authenticated employee's residential address.\n\nThe employment is derived from the access token's subject \u2014 there is no\nemployment id in the path. The token must be an employee-role token\n(typically obtained via the OAuth2 assertion grant with subject\n`urn:remote-api:employee:employment:`).\n\nThis endpoint requires country-specific data. The exact required fields vary depending on which\ncountry the authenticated employee's employment is in. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `address_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage addresses (`address:write`) |\n" }, "response": [ { "id": "68ac60ce-b6df-4f9c-9410-8678921f5414", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-68ac60ce-b6df-4f9c-9410-8678921f5414" }, { "id": "ff73814b-af28-4d3a-8fed-efab215db54f", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ff73814b-af28-4d3a-8fed-efab215db54f" }, { "id": "4266cd72-4617-45af-b1c0-7c98c61f2439", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4266cd72-4617-45af-b1c0-7c98c61f2439" }, { "id": "de6d133b-593e-476b-84ee-910172c5b69f", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-de6d133b-593e-476b-84ee-910172c5b69f" }, { "id": "f3cd3739-a40e-4c18-a4db-777b3ec1d0a8", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f3cd3739-a40e-4c18-a4db-777b3ec1d0a8" }, { "id": "42743d08-16b7-45fd-a6b9-2f5a9485f4fe", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-42743d08-16b7-45fd-a6b9-2f5a9485f4fe" }, { "id": "5e2a348c-afd7-45b9-9e08-d53dd2b4c715", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/address?address_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "address" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5e2a348c-afd7-45b9-9e08-d53dd2b4c715" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-08931249-696a-4346-ad58-f128981b4730" } ], "id": "159b27f3-3dd3-4f28-9f1c-d196905c8b99", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-159b27f3-3dd3-4f28-9f1c-d196905c8b99" }, { "name": "federal-taxes", "item": [ { "name": "Submit employee federal taxes", "id": "660a4f3c-82c4-4597-bafe-22029119d530", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] }, "description": "Submits the authenticated employee's US federal tax (W-4) details.\n\nAvailable for US Global Payroll employees once they reach the\npost-enrollment state. Calls made before then return a 404.\n\nThis endpoint requires country-specific data. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `global_payroll_federal_taxes`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage personal details (`personal_detail:write`) |\n" }, "response": [ { "id": "88a2e1e7-0a56-41b1-b3e4-36eb40fafb0e", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-88a2e1e7-0a56-41b1-b3e4-36eb40fafb0e" }, { "id": "447fffa0-78a7-4357-aa45-aa97447cbd77", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-447fffa0-78a7-4357-aa45-aa97447cbd77" }, { "id": "65c28328-59ac-432c-9884-e08d8f65be16", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-65c28328-59ac-432c-9884-e08d8f65be16" }, { "id": "cac2f158-9e05-47bc-a590-b040813c4452", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cac2f158-9e05-47bc-a590-b040813c4452" }, { "id": "5ff39ecf-68aa-4f5e-bda2-bd09c9be75cb", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5ff39ecf-68aa-4f5e-bda2-bd09c9be75cb" }, { "id": "46f2931f-f423-4197-85cc-871c2f63e599", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-46f2931f-f423-4197-85cc-871c2f63e599" }, { "id": "22d1c20b-74ca-462b-bc7c-2f9d5f0b27b7", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"federal_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/federal-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "federal-taxes" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-22d1c20b-74ca-462b-bc7c-2f9d5f0b27b7" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-660a4f3c-82c4-4597-bafe-22029119d530" } ], "id": "785d9bec-19a2-46e3-bf56-4c029853d962", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-785d9bec-19a2-46e3-bf56-4c029853d962" }, { "name": "emergency-contact", "item": [ { "name": "Show employee emergency contact", "id": "7e028494-6304-4a7a-ad01-d3dc8b894e8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] }, "description": "Returns the authenticated employee's emergency contact.\n\nThe employment is derived from the access token's subject \u2014 there is no\nemployment id in the path.\n\nThis endpoint requires country-specific data. The exact required fields vary depending on which\ncountry the authenticated employee's employment is in. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `emergency_contact_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View emergency contacts (`emergency_contact:read`) | Manage emergency contacts (`emergency_contact:write`) |\n" }, "response": [ { "id": "22b84118-cbd1-4897-8328-a136db79919e", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-22b84118-cbd1-4897-8328-a136db79919e" }, { "id": "d8d842cf-f9d9-4561-9869-2c78c936f281", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d8d842cf-f9d9-4561-9869-2c78c936f281" }, { "id": "3ddf5fdf-6b5b-4cad-998e-2e500086ff4e", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3ddf5fdf-6b5b-4cad-998e-2e500086ff4e" }, { "id": "d0fc6249-0b40-4026-9b6e-1be7240d22e5", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d0fc6249-0b40-4026-9b6e-1be7240d22e5" }, { "id": "1ff9b154-3a19-494f-ad1a-ed1531025dd2", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1ff9b154-3a19-494f-ad1a-ed1531025dd2" }, { "id": "cf716cf3-06bb-4d6d-89c3-7d5b417d86a1", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cf716cf3-06bb-4d6d-89c3-7d5b417d86a1" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7e028494-6304-4a7a-ad01-d3dc8b894e8b" }, { "name": "Update employee emergency contact", "id": "f571c30b-89d9-496f-8d00-0a307d0e03a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] }, "description": "Updates the authenticated employee's emergency contact.\n\nThe employment is derived from the access token's subject \u2014 there is no\nemployment id in the path. The token must be an employee-role token\n(typically obtained via the OAuth2 assertion grant with subject\n`urn:remote-api:employee:employment:`).\n\nThis endpoint requires country-specific data. The exact required fields vary depending on which\ncountry the authenticated employee's employment is in. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `emergency_contact_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage emergency contacts (`emergency_contact:write`) |\n" }, "response": [ { "id": "2ee70b58-4d16-49f9-af57-bfc5c593116e", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2ee70b58-4d16-49f9-af57-bfc5c593116e" }, { "id": "76b6d105-1a5d-4899-9350-fa39d9931937", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-76b6d105-1a5d-4899-9350-fa39d9931937" }, { "id": "2388ce2f-cf06-43a9-97d2-5c51857b0d7a", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2388ce2f-cf06-43a9-97d2-5c51857b0d7a" }, { "id": "ec420596-f25a-427c-9dba-b166f36edfc6", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ec420596-f25a-427c-9dba-b166f36edfc6" }, { "id": "ba2dbed5-ed15-47e6-82f4-8a42b0b0efe4", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ba2dbed5-ed15-47e6-82f4-8a42b0b0efe4" }, { "id": "ac61c248-eeb7-46e4-baf2-fd729e75a7f8", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ac61c248-eeb7-46e4-baf2-fd729e75a7f8" }, { "id": "01724f1a-d909-4e42-8a30-ba52f6d1265e", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emergency_contact_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/emergency-contact?emergency_contact_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "emergency-contact" ], "query": [ { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-01724f1a-d909-4e42-8a30-ba52f6d1265e" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f571c30b-89d9-496f-8d00-0a307d0e03a7" } ], "id": "d729100e-ea58-4937-b7ae-4587088fc70d", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d729100e-ea58-4937-b7ae-4587088fc70d" }, { "name": "personal-details", "item": [ { "name": "Show employee personal details", "id": "cc40d335-120c-46c4-be8b-e938eb1368df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] }, "description": "Returns the authenticated employee's personal details.\n\nThis endpoint requires country-specific data. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `personal_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View personal details (`personal_detail:read`) | Manage personal details (`personal_detail:write`) |\n" }, "response": [ { "id": "a905b345-0994-4c69-8c7c-4e7de7f86116", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a905b345-0994-4c69-8c7c-4e7de7f86116" }, { "id": "a3289bfb-2461-4d0f-b4ba-b61d7497d061", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a3289bfb-2461-4d0f-b4ba-b61d7497d061" }, { "id": "44968ac7-62da-49da-a9ae-dcb31d2c0aeb", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-44968ac7-62da-49da-a9ae-dcb31d2c0aeb" }, { "id": "099fa1f9-a87a-4256-9066-5f030e795ac3", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-099fa1f9-a87a-4256-9066-5f030e795ac3" }, { "id": "045ef876-29e7-4534-8720-18a015ce7a4b", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-045ef876-29e7-4534-8720-18a015ce7a4b" }, { "id": "440f1700-9262-4fd9-ab19-0215f636a7cf", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-440f1700-9262-4fd9-ab19-0215f636a7cf" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cc40d335-120c-46c4-be8b-e938eb1368df" }, { "name": "Update employee personal details", "id": "f9b3895c-bf32-4562-95b2-306896228376", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] }, "description": "Updates the authenticated employee's personal details (date of birth,\nnational ID, nationality, etc.).\n\nThis endpoint requires country-specific data. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `personal_details`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage personal details (`personal_detail:write`) |\n" }, "response": [ { "id": "495c86bf-ce1c-4525-8b7b-fb184017215b", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"id\": \"\",\n \"status\": \"archived\",\n \"type\": \"direct_employee\",\n \"updated_at\": \"\",\n \"user_status\": \"active\",\n \"address_details\": {},\n \"administrative_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"contract_details\": {},\n \"contract_origin\": \"custom_remote_contract\",\n \"emergency_contact_details\": {},\n \"personal_details\": {},\n \"pricing_plan_details\": {}\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-495c86bf-ce1c-4525-8b7b-fb184017215b" }, { "id": "23838361-cdb0-4443-8f00-4109e82fb0b1", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-23838361-cdb0-4443-8f00-4109e82fb0b1" }, { "id": "cbb6c273-0288-4a08-a2d9-9a1b5e013549", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cbb6c273-0288-4a08-a2d9-9a1b5e013549" }, { "id": "e35d484c-5dcd-40d1-989c-9acb3085cbaf", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e35d484c-5dcd-40d1-989c-9acb3085cbaf" }, { "id": "2dc4f562-7c0a-40a4-80bc-32e1be571da0", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2dc4f562-7c0a-40a4-80bc-32e1be571da0" }, { "id": "ec41a126-e017-4251-b042-2a4b35147bff", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ec41a126-e017-4251-b042-2a4b35147bff" }, { "id": "d2b51ade-cef3-4eb8-b360-068c3d163606", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"personal_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/personal-details?personal_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "personal-details" ], "query": [ { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d2b51ade-cef3-4eb8-b360-068c3d163606" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f9b3895c-bf32-4562-95b2-306896228376" } ], "id": "f5843e06-e7e3-4953-a993-b0540ada0172", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f5843e06-e7e3-4953-a993-b0540ada0172" }, { "name": "state-taxes", "item": [ { "name": "{jurisdiction}", "item": [ { "name": "Submit employee state taxes", "id": "4617c48f-d863-47dd-8304-746137a40c97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "id": "ca19f2bc-d19d-4ede-8b32-3bfebc80144a", "key": "jurisdiction", "value": "", "description": "(Required) Two-letter US state/jurisdiction code" } ] }, "description": "Submits the authenticated employee's US state tax withholding answers for a\nsingle jurisdiction (e.g. `NY`).\n\nAvailable for US Global Payroll employees once they reach the post-enrollment\nstate, at which point the per-jurisdiction state tax task exists.\n\nThis endpoint requires country/jurisdiction-specific data. Query the\n[Show form schema](#tag/Countries/operation/get_show_form_country) endpoint with `global_payroll_state_taxes`\nas the form name to discover the schema for a given country.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage personal details (`personal_detail:write`) |\n" }, "response": [ { "id": "7857fc5c-f2b8-4aad-8451-9a163c74411d", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7857fc5c-f2b8-4aad-8451-9a163c74411d" }, { "id": "f5a8fa87-f451-4451-8728-9e6ad4429434", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f5a8fa87-f451-4451-8728-9e6ad4429434" }, { "id": "bb11dbab-de45-4b65-b362-399cc976dd63", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bb11dbab-de45-4b65-b362-399cc976dd63" }, { "id": "2b4c8d02-a5e3-4263-8801-ba4ce5a607c5", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2b4c8d02-a5e3-4263-8801-ba4ce5a607c5" }, { "id": "2c313c21-ba0a-43c1-ad26-84c9d64b8605", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2c313c21-ba0a-43c1-ad26-84c9d64b8605" }, { "id": "e3bfec1c-1e8b-4d2e-ba4b-eea9eb3f68f0", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e3bfec1c-1e8b-4d2e-ba4b-eea9eb3f68f0" }, { "id": "d6d96a12-2dad-42ad-b948-1b6c29c8dc41", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"state_taxes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employee/state-taxes/:jurisdiction", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "state-taxes", ":jurisdiction" ], "variable": [ { "key": "jurisdiction" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d6d96a12-2dad-42ad-b948-1b6c29c8dc41" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4617c48f-d863-47dd-8304-746137a40c97" } ], "id": "3af6ba9c-c090-4a77-b6b2-604090945c2c", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3af6ba9c-c090-4a77-b6b2-604090945c2c" } ], "id": "3266593f-dfab-4e5c-b437-f094800d838d", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3266593f-dfab-4e5c-b437-f094800d838d" } ], "id": "386e19d2-c82d-4140-aa7f-8193463260fa", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-386e19d2-c82d-4140-aa7f-8193463260fa" }, { "name": "identity-verification", "item": [ { "name": "{employment_id}", "item": [ { "name": "decline", "item": [ { "name": "Decline Identity Verification", "id": "37961a75-8ede-465f-848e-0a869d4fb487", "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/identity-verification/:employment_id/decline", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "decline" ], "variable": [ { "id": "1c65bae2-e5bd-426b-a58e-dd160e259508", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Declines the identity verification of an employee.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) |\n" }, "response": [ { "id": "db17f824-3b93-43e3-a6d5-c15223587913", "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/identity-verification/:employment_id/decline", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "decline" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-db17f824-3b93-43e3-a6d5-c15223587913" }, { "id": "ed36d17f-4353-4acd-a68a-1876d779b29f", "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/identity-verification/:employment_id/decline", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "decline" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ed36d17f-4353-4acd-a68a-1876d779b29f" }, { "id": "96e54a05-b9fb-4213-a8cf-d13998a04274", "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/identity-verification/:employment_id/decline", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "decline" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-96e54a05-b9fb-4213-a8cf-d13998a04274" }, { "id": "91686d7b-7c87-4aea-9ec3-4fbf2c300e3f", "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/identity-verification/:employment_id/decline", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "decline" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-91686d7b-7c87-4aea-9ec3-4fbf2c300e3f" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-37961a75-8ede-465f-848e-0a869d4fb487" } ], "id": "f5a1aaa0-007c-41a8-9282-c15d9ef759e1", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f5a1aaa0-007c-41a8-9282-c15d9ef759e1" }, { "name": "verify", "item": [ { "name": "Verify Employment Identity", "id": "89bb4276-62eb-4293-b7e4-592209c0b091", "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/identity-verification/:employment_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "verify" ], "variable": [ { "id": "8f21b731-4f3e-4a60-9457-21328260f5fd", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Endpoint to confirms the employment profile is from the actual employee\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) |\n" }, "response": [ { "id": "02c2cd7d-b6ac-48d2-b13e-fa97271fd02c", "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/identity-verification/:employment_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "verify" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-02c2cd7d-b6ac-48d2-b13e-fa97271fd02c" }, { "id": "85d31012-feca-4423-9d17-7fa0f1147f38", "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/identity-verification/:employment_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "verify" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-85d31012-feca-4423-9d17-7fa0f1147f38" }, { "id": "9a52202d-9f39-415b-8de2-bffaa31cbcbd", "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/identity-verification/:employment_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "verify" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9a52202d-9f39-415b-8de2-bffaa31cbcbd" }, { "id": "0232f1d5-c33f-493f-8a4f-946cd3ebd998", "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/identity-verification/:employment_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id", "verify" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0232f1d5-c33f-493f-8a4f-946cd3ebd998" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-89bb4276-62eb-4293-b7e4-592209c0b091" } ], "id": "778294c9-ba01-4679-8f9b-078d0eae1416", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-778294c9-ba01-4679-8f9b-078d0eae1416" }, { "name": "Get Employment Profile", "id": "03716d33-600d-44ba-9c13-45de559d37b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/identity-verification/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":employment_id" ], "variable": [ { "id": "c41c1b8d-7fbb-4a36-a0b7-2bf6b07b03b8", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Gets necessary information to perform the identity verification of an employee.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View identity verification (`identity_verification:read`) | Manage identity verification (`identity_verification:write`) |\n" }, "response": [ { "id": "446486a7-753c-4260-92aa-ce3ba7ae0ec0", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/identity-verification/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":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 \"identity_verification_data\": {\n \"contract_id\": \"\",\n \"status\": \"\",\n \"employment_image\": {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n \"employment_document\": {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-446486a7-753c-4260-92aa-ce3ba7ae0ec0" }, { "id": "222afe8b-8c7d-47d4-bc9c-38190c985d79", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/identity-verification/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-222afe8b-8c7d-47d4-bc9c-38190c985d79" }, { "id": "a1ac3138-7af2-4dea-b7ea-7378a1febf5f", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/identity-verification/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a1ac3138-7af2-4dea-b7ea-7378a1febf5f" }, { "id": "ffb087d4-d991-4bcf-8be6-629fb1d1d6f7", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/identity-verification/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "identity-verification", ":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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ffb087d4-d991-4bcf-8be6-629fb1d1d6f7" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-03716d33-600d-44ba-9c13-45de559d37b1" } ], "id": "56d67ab5-fc7f-474f-bc1c-b5139f146532", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-56d67ab5-fc7f-474f-bc1c-b5139f146532" } ], "id": "1f21154c-1e9b-4bb7-b625-76dbecfb9af3", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1f21154c-1e9b-4bb7-b625-76dbecfb9af3" }, { "name": "onboarding", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "pre-onboarding-requirements", "item": [ { "name": "{requirement_slug}", "item": [ { "name": "acknowledge", "item": [ { "name": "Remove a pre-onboarding acknowledgement", "id": "730f22e6-b555-463a-8237-0174a26bbb2e", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "id": "39497e7f-438c-4a53-8aad-3d8167658e49", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "01fc6ddc-d0ff-43b6-a42b-917468ea1c1f", "key": "requirement_slug", "value": "", "description": "(Required) Pre-onboarding requirement slug" } ] }, "description": "Removes a previously recorded acknowledgement. Rejected once a requirement that depends on\nthis acknowledgement has been signed/completed.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "2bf1a0e1-f4e2-41a8-aa1c-5e7783b4b4de", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2bf1a0e1-f4e2-41a8-aa1c-5e7783b4b4de" }, { "id": "cca8ac9a-eb6f-46d6-a700-76cf15d7bc0c", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cca8ac9a-eb6f-46d6-a700-76cf15d7bc0c" }, { "id": "74687890-e92f-4b9c-ad80-57e92b1956d1", "name": "Forbidden", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-74687890-e92f-4b9c-ad80-57e92b1956d1" }, { "id": "8a7a6c09-94b8-4080-b52e-515268705074", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8a7a6c09-94b8-4080-b52e-515268705074" }, { "id": "6101b9cd-53a6-49d9-b3dd-710423568b32", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6101b9cd-53a6-49d9-b3dd-710423568b32" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-730f22e6-b555-463a-8237-0174a26bbb2e" }, { "name": "Acknowledge a pre-onboarding acknowledgement requirement", "id": "3a997d0f-5ca2-47ab-9068-3d647eaddfec", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "id": "7684ce4a-ed30-4673-a150-291ba240c7f4", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "1779ce1e-1fa3-43f7-82d6-313eceb9dde4", "key": "requirement_slug", "value": "", "description": "(Required) Pre-onboarding requirement slug" } ] }, "description": "Records an acknowledgement for an acknowledgement requirement. Rejected if the requirement\nis blocked by an unmet dependency or has already been acknowledged.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "91bd16f0-7f29-4dad-b1a3-5f5d2363d236", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"pre_onboarding_acknowledgement\": {\n \"id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-91bd16f0-7f29-4dad-b1a3-5f5d2363d236" }, { "id": "3f567f4f-e7b6-4b2b-9c3e-1eeb8c1fe234", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3f567f4f-e7b6-4b2b-9c3e-1eeb8c1fe234" }, { "id": "bde72702-f370-4f68-95c1-f91f85296545", "name": "Forbidden", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bde72702-f370-4f68-95c1-f91f85296545" }, { "id": "a44bf41a-731f-4d95-a057-15f8997ca91e", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a44bf41a-731f-4d95-a057-15f8997ca91e" }, { "id": "b6ba7f1f-bb76-4df2-a041-0a574ecef4ed", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "acknowledge" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b6ba7f1f-bb76-4df2-a041-0a574ecef4ed" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3a997d0f-5ca2-47ab-9068-3d647eaddfec" } ], "id": "d11e27ff-cc6b-434b-9d8b-30c73c746ecb", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d11e27ff-cc6b-434b-9d8b-30c73c746ecb" }, { "name": "documents", "item": [ { "name": "Find or create a document for a pre-onboarding requirement", "id": "dc7f4783-6130-4427-83f6-1d52124029ae", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "documents" ], "variable": [ { "id": "9cc1161e-e375-441f-8b19-812d4ad9b7b3", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "de22f74b-faa2-4b41-b753-fe46e806c511", "key": "requirement_slug", "value": "", "description": "(Required) Pre-onboarding requirement slug" } ] }, "description": "Finds an existing unsigned pre-onboarding document for the given document requirement, or\ncreates a new one. Idempotent: repeated calls return the same document until it is signed.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "b1ecb17a-ad7d-4e7d-9653-b53e615d414c", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "documents" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"pre_onboarding_document\": {\n \"id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b1ecb17a-ad7d-4e7d-9653-b53e615d414c" }, { "id": "40725ec2-3d51-440a-93d4-5b3dbdc2bdb3", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "documents" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-40725ec2-3d51-440a-93d4-5b3dbdc2bdb3" }, { "id": "a568f6de-deb8-496b-8510-beed684555da", "name": "Forbidden", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "documents" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a568f6de-deb8-496b-8510-beed684555da" }, { "id": "70ab47b9-3597-4b97-b6fb-57c11bc25078", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "documents" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-70ab47b9-3597-4b97-b6fb-57c11bc25078" }, { "id": "7989e360-bc58-4e66-9975-119a150ce4a4", "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/onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements", ":requirement_slug", "documents" ], "variable": [ { "key": "employment_id" }, { "key": "requirement_slug" } ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7989e360-bc58-4e66-9975-119a150ce4a4" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-dc7f4783-6130-4427-83f6-1d52124029ae" } ], "id": "163fc1cf-d8d1-4f55-9268-ec96b63e746d", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-163fc1cf-d8d1-4f55-9268-ec96b63e746d" } ], "id": "4103e576-87af-4463-abb6-893536c40558", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4103e576-87af-4463-abb6-893536c40558" }, { "name": "List pre-onboarding requirements for an employment", "id": "fb3225e7-cf6b-4f4f-adc0-207845be1103", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements" ], "variable": [ { "id": "a473d6d9-a16a-43e8-bc8b-208603913a1f", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the list of pre-onboarding requirements \u2014 both documents (e.g. master service\nagreements, individual labour agreements) and acknowledgements \u2014 that must be fulfilled\nbefore the given employment can be onboarded. Each requirement carries its `type`, current\n`status`, and the requirement it `depends_on` (if any).\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "4baf41aa-d0e6-4bbd-9d0f-d8beda748e1e", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements" ], "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 {\n \"slug\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"acknowledgement\",\n \"status\": \"finished\",\n \"freeze_employment_data\": \"\",\n \"supports_redlining\": \"\",\n \"redlining_help_email\": \"\",\n \"depends_on_requirement\": {\n \"description\": \"The requirement that must be fulfilled before this one becomes available (if any).\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"acknowledgement\",\n \"status\": \"finished\",\n \"freeze_employment_data\": \"\",\n \"supports_redlining\": \"\",\n \"redlining_help_email\": \"\",\n \"depends_on_requirement\": {\n \"description\": \"The requirement that must be fulfilled before this one becomes available (if any).\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4baf41aa-d0e6-4bbd-9d0f-d8beda748e1e" }, { "id": "bc6bd4b1-75d8-4f00-857c-89d5b3887797", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-bc6bd4b1-75d8-4f00-857c-89d5b3887797" }, { "id": "7cf66710-b268-47bc-bb24-941890239b52", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7cf66710-b268-47bc-bb24-941890239b52" }, { "id": "6c0f6b14-0843-49c4-b1be-b496a75d43e2", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-requirements" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6c0f6b14-0843-49c4-b1be-b496a75d43e2" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fb3225e7-cf6b-4f4f-adc0-207845be1103" } ], "id": "01677435-2edf-43ee-9bd2-f3b5afc87ce9", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-01677435-2edf-43ee-9bd2-f3b5afc87ce9" }, { "name": "pre-onboarding-document-requirements", "item": [ { "name": "List pre-onboarding document requirements for an employment", "id": "0e7c185f-d8e3-4719-b5f9-4129af1d2744", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-document-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-document-requirements" ], "variable": [ { "id": "047e9db7-bd90-452a-afb2-0bb6d8a50fca", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the list of pre-onboarding document requirements (e.g. master service agreements,\nindividual labour agreements) that must be fulfilled before the given employment can be onboarded.\n\nDeprecated: use `GET /onboarding/employments/:employment_id/pre-onboarding-requirements` instead,\nwhich returns both document and acknowledgement requirements.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "f2b6b1b8-819f-426d-a230-4befa45c892a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-document-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-document-requirements" ], "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 {\n \"slug\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"supports_redlining\": \"\",\n \"needs_constraints_ack\": \"\",\n \"depends_on_requirement\": {\n \"description\": \"The requirement that must be fulfilled before this one becomes available (if any).\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"document_constraints_ack_at\": \"\",\n \"freeze_employment_data\": \"\",\n \"redlining_help_email\": \"\",\n \"status\": \"finished\"\n },\n {\n \"slug\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"supports_redlining\": \"\",\n \"needs_constraints_ack\": \"\",\n \"depends_on_requirement\": {\n \"description\": \"The requirement that must be fulfilled before this one becomes available (if any).\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"document_constraints_ack_at\": \"\",\n \"freeze_employment_data\": \"\",\n \"redlining_help_email\": \"\",\n \"status\": \"awaiting_signatures\"\n }\n ]\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f2b6b1b8-819f-426d-a230-4befa45c892a" }, { "id": "c73c2c4c-c9e7-4f0e-90ca-8b3bfed1f29b", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-document-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-document-requirements" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c73c2c4c-c9e7-4f0e-90ca-8b3bfed1f29b" }, { "id": "1c622504-7f41-4d71-a36f-a92e0479b14c", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-document-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-document-requirements" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1c622504-7f41-4d71-a36f-a92e0479b14c" }, { "id": "19b11d73-e87e-4a49-9cd2-576a7e3e1be9", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-document-requirements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-document-requirements" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-19b11d73-e87e-4a49-9cd2-576a7e3e1be9" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0e7c185f-d8e3-4719-b5f9-4129af1d2744" } ], "id": "d6042f7a-138e-445a-a143-8937f1724a96", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d6042f7a-138e-445a-a143-8937f1724a96" }, { "name": "pre-onboarding-documents", "item": [ { "name": "{id}", "item": [ { "name": "sign", "item": [ { "name": "Sign a pre-onboarding document", "id": "0f3a5376-b97f-4bdb-a34a-82cf60d26ba4", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "id": "8f7e5a45-bb48-4c12-b901-7463d80d75f5", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "107435ac-bf0d-4ab8-ab13-fb2c9a73fe1b", "key": "id", "value": "", "description": "(Required) Pre-onboarding document ID" } ] }, "description": "Signs the latest contract document associated with the given pre-onboarding document on behalf\nof the company signatory.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "6c66b147-e50a-4386-9db8-9fb5e79574cd", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6c66b147-e50a-4386-9db8-9fb5e79574cd" }, { "id": "cf6f746d-5837-4038-a07d-c516b9e594c6", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-cf6f746d-5837-4038-a07d-c516b9e594c6" }, { "id": "e3558536-1e43-4073-b25f-0606bcd5234b", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e3558536-1e43-4073-b25f-0606bcd5234b" }, { "id": "e903f154-8ce0-4ebc-a7ca-af6364956da4", "name": "Forbidden", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "key": "employment_id" }, { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e903f154-8ce0-4ebc-a7ca-af6364956da4" }, { "id": "1abe3ee7-fc51-4cff-9884-8c60cfc9febe", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-1abe3ee7-fc51-4cff-9884-8c60cfc9febe" }, { "id": "482896a8-4a44-4735-8a79-df1feb02c64d", "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 \"signature\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id/sign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id", "sign" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-482896a8-4a44-4735-8a79-df1feb02c64d" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-0f3a5376-b97f-4bdb-a34a-82cf60d26ba4" } ], "id": "567a4744-16b3-44e8-9120-52152af651ae", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-567a4744-16b3-44e8-9120-52152af651ae" }, { "name": "Retrieve a pre-onboarding document with its rendered PDF content", "id": "5d68afb8-54c8-4534-b9f0-ea489ac5d4e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id" ], "variable": [ { "id": "7a110cf1-26af-48d9-adfc-5968c2b92d4b", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "5c218fc5-c53e-442d-baf6-0678101814cd", "key": "id", "value": "", "description": "(Required) Pre-onboarding document ID" } ] }, "description": "Returns the rendered contract PDF (base64-encoded) and the list of signatories for the given\npre-onboarding document. The `content` field is prefixed with `data:application/pdf;base64,` so\nit can be embedded directly in a document viewer.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "a95635aa-20c7-4189-9b45-34951a44b426", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id" ], "variable": [ { "key": "employment_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"pre_onboarding_document\": {\n \"name\": \"\",\n \"content\": \"\",\n \"signatories\": [\n {\n \"type\": \"admin\",\n \"status\": \"signed\",\n \"email\": \"\",\n \"name\": \"\",\n \"signature\": \"\",\n \"signature_method\": \"in_platform\",\n \"signature_type\": \"ses\",\n \"signed_at\": \"\",\n \"user_id\": \"\"\n },\n {\n \"type\": \"external\",\n \"status\": \"pending\",\n \"email\": \"\",\n \"name\": \"\",\n \"signature\": \"\",\n \"signature_method\": \"in_platform\",\n \"signature_type\": \"ses\",\n \"signed_at\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"status\": \"finished\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a95635aa-20c7-4189-9b45-34951a44b426" }, { "id": "09123bba-3533-4ca8-9448-d04eeb43fd7b", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-09123bba-3533-4ca8-9448-d04eeb43fd7b" }, { "id": "3b0d0e01-f154-4dd1-aacb-4fb6f3bc4ffc", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id" ], "variable": [ { "key": "employment_id" }, { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3b0d0e01-f154-4dd1-aacb-4fb6f3bc4ffc" }, { "id": "874690fd-b8d3-4329-b362-e5255ad79f83", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents", ":id" ], "variable": [ { "key": "employment_id" }, { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-874690fd-b8d3-4329-b362-e5255ad79f83" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5d68afb8-54c8-4534-b9f0-ea489ac5d4e1" } ], "id": "114cc7c6-9b92-4133-9d60-ed1ca0922a3c", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-114cc7c6-9b92-4133-9d60-ed1ca0922a3c" }, { "name": "Find or create a pre-onboarding document for an employment", "id": "ba4d1107-d495-40d3-9e16-0d19ceea92ee", "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 \"pre_onboarding_document_requirement_slug\": \"\",\n \"constraints_ack_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents" ], "variable": [ { "id": "c7953f9c-2a6d-473e-b158-1c4697a2aaeb", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Finds an existing unsigned pre-onboarding document for the given requirement, or creates a new one.\nIdempotent: repeated calls with the same `pre_onboarding_document_requirement_slug` return the same\ndocument until it is signed.\n\nDeprecated: use\n`POST /onboarding/employments/:employment_id/pre-onboarding-requirements/:requirement_slug/documents` instead.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "74c2c34e-8502-4d24-b281-11bf21fd7abf", "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 \"pre_onboarding_document_requirement_slug\": \"\",\n \"constraints_ack_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents" ], "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 \"pre_onboarding_document\": {\n \"id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-74c2c34e-8502-4d24-b281-11bf21fd7abf" }, { "id": "3c707454-996f-462d-8e70-6a996947ddc7", "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 \"pre_onboarding_document_requirement_slug\": \"\",\n \"constraints_ack_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3c707454-996f-462d-8e70-6a996947ddc7" }, { "id": "254cc05a-6eeb-4255-9854-d2bf563c2b9f", "name": "Forbidden", "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 \"pre_onboarding_document_requirement_slug\": \"\",\n \"constraints_ack_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-254cc05a-6eeb-4255-9854-d2bf563c2b9f" }, { "id": "a7d3b743-6deb-4d4a-a9a9-8eed6d715cc0", "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 \"pre_onboarding_document_requirement_slug\": \"\",\n \"constraints_ack_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a7d3b743-6deb-4d4a-a9a9-8eed6d715cc0" }, { "id": "7edc16e0-86f7-4b06-abc5-c9d6502ad516", "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 \"pre_onboarding_document_requirement_slug\": \"\",\n \"constraints_ack_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/onboarding/employments/:employment_id/pre-onboarding-documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding", "employments", ":employment_id", "pre-onboarding-documents" ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7edc16e0-86f7-4b06-abc5-c9d6502ad516" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ba4d1107-d495-40d3-9e16-0d19ceea92ee" } ], "id": "fd4d2e46-224e-4434-9205-e2b759edd43e", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fd4d2e46-224e-4434-9205-e2b759edd43e" } ], "id": "6e5d65c8-0f2a-4bd6-b68b-26642b6964f2", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6e5d65c8-0f2a-4bd6-b68b-26642b6964f2" } ], "id": "4cf2cf82-3ac2-4f62-8ae4-e58f3c3269ef", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4cf2cf82-3ac2-4f62-8ae4-e58f3c3269ef" } ], "id": "389a64e1-371a-4921-8073-294fa3c525dc", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-389a64e1-371a-4921-8073-294fa3c525dc" }, { "name": "risk-reserve", "item": [ { "name": "Create risk reserve", "id": "62a5cbde-5564-4fd5-a077-7960258be39f", "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_slug\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/risk-reserve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "risk-reserve" ] }, "description": "Create a new risk reserve\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) |\n" }, "response": [ { "id": "7fd929e3-20ed-4c25-b38e-0a66baaf8e1b", "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_slug\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/risk-reserve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "risk-reserve" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7fd929e3-20ed-4c25-b38e-0a66baaf8e1b" }, { "id": "abbc07d3-13b4-4efa-874b-a4aad551428e", "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_slug\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/risk-reserve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "risk-reserve" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-abbc07d3-13b4-4efa-874b-a4aad551428e" }, { "id": "a54848ce-c540-4fc5-8104-fbb352cdfe23", "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_slug\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/risk-reserve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "risk-reserve" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a54848ce-c540-4fc5-8104-fbb352cdfe23" }, { "id": "17889c61-c270-4231-8948-9e75a7ce890d", "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_slug\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/risk-reserve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "risk-reserve" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-17889c61-c270-4231-8948-9e75a7ce890d" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-62a5cbde-5564-4fd5-a077-7960258be39f" } ], "id": "6d29dec8-7a04-455c-b061-d960a069e8e9", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6d29dec8-7a04-455c-b061-d960a069e8e9" }, { "name": "files", "item": [ { "name": "{id}", "item": [ { "name": "Download file", "id": "a46eaca8-9f53-4fd4-984e-54072111c03a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "files", ":id" ], "variable": [ { "id": "5669d62f-9cd0-476d-8f9a-bbb33294f558", "key": "id", "value": "", "description": "(Required) File ID" } ] }, "description": "Downloads a file.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "ba214388-fb9b-4150-98e2-34e9af1a65fc", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "files", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"file\": {\n \"content\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ba214388-fb9b-4150-98e2-34e9af1a65fc" }, { "id": "50b95a25-c9ae-4fde-b479-29178b29d871", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "files", ":id" ], "variable": [ { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-50b95a25-c9ae-4fde-b479-29178b29d871" }, { "id": "e2ad2b11-a909-4e6e-81d1-52f409ec3d67", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "files", ":id" ], "variable": [ { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e2ad2b11-a909-4e6e-81d1-52f409ec3d67" }, { "id": "d91e1339-657b-45b1-8288-410c0a17bb59", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "files", ":id" ], "variable": [ { "key": "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d91e1339-657b-45b1-8288-410c0a17bb59" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a46eaca8-9f53-4fd4-984e-54072111c03a" } ], "id": "aabc58df-4a26-43c2-8bee-4e7a478437fe", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-aabc58df-4a26-43c2-8bee-4e7a478437fe" } ], "id": "50826c41-1475-4e8f-bc8b-bbf6f3f5ec7a", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-50826c41-1475-4e8f-bc8b-bbf6f3f5ec7a" }, { "name": "company", "item": [ { "name": "{company_id}", "item": [ { "name": "cost-center-allocations", "item": [ { "name": "List cost center allocations for a company", "id": "9872e86d-4c5d-4b4e-b375-b558920572e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/company/:company_id/cost-center-allocations?status=active&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company", ":company_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "3e63794f-3571-4323-b4f3-85b7967292d8", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Lists all employments under a company with their cost center allocations, grouped by employment.\nEach entry includes the employment's legal entity IDs and the list of cost center allocations\nassigned to it, with each allocation's cost center, allocated percentage, and effective period.\nEmployments with no cost center allocations are included with an empty list.\n\nUse the `status` query parameter to return only `active`, `scheduled`, or `expired` allocations.\nWhen omitted, all allocations are returned.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "151b2877-11d0-49a2-9ff7-4c1600611be9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company/:company_id/cost-center-allocations?status=active&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company", ":company_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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 \"current_page\": \"\",\n \"employments\": [\n {\n \"employment_id\": \"\",\n \"cost_center_allocations\": [\n {\n \"id\": \"\",\n \"cost_center\": {\n \"name\": \"\",\n \"code\": \"\",\n \"slug\": \"\"\n },\n \"percentage\": \"\",\n \"effective_from\": \"\",\n \"effective_to\": \"\",\n \"status\": \"active\"\n },\n {\n \"id\": \"\",\n \"cost_center\": {\n \"name\": \"\",\n \"code\": \"\",\n \"slug\": \"\"\n },\n \"percentage\": \"\",\n \"effective_from\": \"\",\n \"effective_to\": \"\",\n \"status\": \"scheduled\"\n }\n ],\n \"bill_to_legal_entity_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n },\n {\n \"employment_id\": \"\",\n \"cost_center_allocations\": [\n {\n \"id\": \"\",\n \"cost_center\": {\n \"name\": \"\",\n \"code\": \"\",\n \"slug\": \"\"\n },\n \"percentage\": \"\",\n \"effective_from\": \"\",\n \"effective_to\": \"\",\n \"status\": \"active\"\n },\n {\n \"id\": \"\",\n \"cost_center\": {\n \"name\": \"\",\n \"code\": \"\",\n \"slug\": \"\"\n },\n \"percentage\": \"\",\n \"effective_from\": \"\",\n \"effective_to\": \"\",\n \"status\": \"expired\"\n }\n ],\n \"bill_to_legal_entity_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-151b2877-11d0-49a2-9ff7-4c1600611be9" }, { "id": "2d5e9d52-22fc-4f61-a54d-2f5bd051cd45", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company/:company_id/cost-center-allocations?status=active&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company", ":company_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-2d5e9d52-22fc-4f61-a54d-2f5bd051cd45" }, { "id": "fde3004b-ed8b-41b7-83a0-52600f016a60", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company/:company_id/cost-center-allocations?status=active&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company", ":company_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fde3004b-ed8b-41b7-83a0-52600f016a60" }, { "id": "7e1fb507-b9d2-40c0-9077-7e8da3510088", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company/:company_id/cost-center-allocations?status=active&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company", ":company_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7e1fb507-b9d2-40c0-9077-7e8da3510088" }, { "id": "11d37499-e087-4307-9754-4bdb2003e9d6", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company/:company_id/cost-center-allocations?status=active&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company", ":company_id", "cost-center-allocations" ], "query": [ { "description": "Filters allocations by status. When omitted, allocations of every status are returned.", "key": "status", "value": "active" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-11d37499-e087-4307-9754-4bdb2003e9d6" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-9872e86d-4c5d-4b4e-b375-b558920572e4" } ], "id": "7108ece6-9371-42e7-b978-898a2eeb2da7", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7108ece6-9371-42e7-b978-898a2eeb2da7" } ], "id": "5ae87613-4d19-405e-afa8-03b53cff7901", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-5ae87613-4d19-405e-afa8-03b53cff7901" } ], "id": "422ad81f-1642-4528-9014-84a43e22b288", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-422ad81f-1642-4528-9014-84a43e22b288" }, { "name": "bulk-employment-jobs", "item": [ { "name": "{job_id}", "item": [ { "name": "rows", "item": [ { "name": "List bulk employment rows", "id": "89a93709-22d2-4886-a9df-2656cf919bca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "076f800f-eabd-4f6e-b41d-8568b9497e43", "key": "job_id", "value": "", "description": "(Required) Bulk employment job id" } ] }, "description": "Returns grouped bulk employment rows, including field-level validation errors in `errors`, row-level failures in `row_errors`, and submission-phase failures in `submission_errors`. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "229432d6-8764-4e9d-a268-deb41da70e11", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "job_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"rows\": {\n \"failures\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"voluptate_b_c\": [\n \"\",\n \"\"\n ],\n \"elit8\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"in_8a\": true,\n \"Excepteur_\": true,\n \"qui_4e\": -89386018.38651773,\n \"voluptate__\": false,\n \"aliquip_88\": -30298350\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"unprocessable\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"sit9ff\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"eu_da9\": 54712542.79803014,\n \"ullamcod\": false\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"unprocessable\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"Lorem_8_e\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"sint_1\": \"aliqua cupidatat magna dolore\",\n \"pariatur_5a7\": true,\n \"in_46f\": 25298899.796883672\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"retryable\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"anim1\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"tempor_f81\": false,\n \"nulla_b\": -67637452\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"deleted\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"successes\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"deseruntd\": [\n \"\",\n \"\"\n ],\n \"dolor_0c5\": [\n \"\",\n \"\"\n ],\n \"Lorem_38a\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"ad92\": -93643354\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"error\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"Excepteur17_\": [\n \"\",\n \"\"\n ],\n \"exercitation2e\": [\n \"\",\n \"\"\n ],\n \"et_7f5\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"cupidatat_8c\": \"eu deserunt magna commodo\",\n \"cupidatat_a4\": true,\n \"non_4\": false\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"imported\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"minim_20c\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"sed6_\": 31574570.30742377,\n \"ameta0\": true,\n \"est_7aa\": -36385271.87664393\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"deleted\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"velitd\": [\n \"\",\n \"\"\n ],\n \"nisi_2_\": [\n \"\",\n \"\"\n ],\n \"dolore_b\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"quis_91\": 39951744.65195382\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"skipped\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"pending\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"sunt_ad\": [\n \"\",\n \"\"\n ],\n \"Excepteurad\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"dolor__\": -62955218,\n \"veniam_a7\": false\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"esse_0ff\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"nulla_0\": \"eu aute proident commodo\",\n \"esse_8\": \"reprehenderit quis exercitation ipsum\",\n \"veniama94\": \"amet do enim sunt\"\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"pending\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"skipped\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"eu_ce7\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"velit4\": 57039805,\n \"elit00_\": \"culpa\"\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"retryable\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"mollitd__\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"estb1\": \"culpa elit ad\"\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"retryable\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"et_d\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"sit_3_e\": false,\n \"irure_e5\": \"enim nisi sed qui\"\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"unprocessable\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"magna_ff\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"Duisef\": 36531752,\n \"ete\": 6907226\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"deleted\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ]\n },\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"counts_by_status\": {\n \"pending\": \"\",\n \"successful\": \"\",\n \"imported\": \"\",\n \"error\": \"\",\n \"unprocessable\": \"\",\n \"deleted\": \"\",\n \"skipped\": \"\",\n \"retryable\": \"\"\n },\n \"counts_by_column\": {\n \"ullamcoa\": {\n \"error\": \"\",\n \"valid\": \"\"\n },\n \"quis7a\": {\n \"error\": \"\",\n \"valid\": \"\"\n },\n \"mollit0\": {\n \"error\": \"\",\n \"valid\": \"\"\n }\n },\n \"ordered_rows\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-229432d6-8764-4e9d-a268-deb41da70e11" }, { "id": "f986c0f5-fc30-4c7c-9d48-d2e93f884e02", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "job_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f986c0f5-fc30-4c7c-9d48-d2e93f884e02" }, { "id": "8c58f7d5-5e6b-4e77-b57f-5f77ce00263c", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "job_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-8c58f7d5-5e6b-4e77-b57f-5f77ce00263c" }, { "id": "7e173504-e83f-4101-b6c7-c4df091105f5", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "job_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7e173504-e83f-4101-b6c7-c4df091105f5" }, { "id": "aff94a8e-54e9-4d77-a307-616bf1faa223", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "job_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-aff94a8e-54e9-4d77-a307-616bf1faa223" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-89a93709-22d2-4886-a9df-2656cf919bca" } ], "id": "a8722c58-3f36-4f60-b319-3bfb491ea12b", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a8722c58-3f36-4f60-b319-3bfb491ea12b" }, { "name": "Show bulk employment job", "id": "7100758b-3a7b-4705-a7f2-c56e698db566", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "id": "cd188a42-598c-401f-bd25-096765b06946", "key": "job_id", "value": "", "description": "(Required) Bulk employment job id" } ] }, "description": "## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "4f7f221d-3e89-4cac-87f0-4a80656b7dc9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"stage\": \"creation\",\n \"status\": \"in_progress\",\n \"name\": \"\",\n \"total_count\": \"\",\n \"processed_count\": \"\",\n \"failed_count\": \"\",\n \"inserted_at\": \"\",\n \"inserted_by\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"personal_details\": {\n \"birthdate\": \"\",\n \"full_preferred_name\": \"\",\n \"gender\": \"\",\n \"gender_description\": \"\",\n \"given_name\": \"\",\n \"is_us_person\": \"\",\n \"mobile_number\": \"\",\n \"nationality\": [\n \"\",\n \"\"\n ],\n \"preferred_name\": \"\",\n \"preferred_pronouns\": \"\",\n \"recovery_number\": \"\",\n \"redacted_fields\": [\n \"\",\n \"\"\n ],\n \"sex\": \"\",\n \"surname\": \"\",\n \"title\": \"mrs\"\n },\n \"profile_picture\": \"\",\n \"status\": \"deleted\"\n },\n \"updated_at\": \"\",\n \"finished_at\": \"\",\n \"metadata\": {},\n \"column_mapping\": {\n \"mapping\": {},\n \"source_columns\": [\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n },\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n }\n ],\n \"unmapped_column_count\": \"\",\n \"unmapped_required_field_count\": \"\",\n \"auto_mapped_columns\": [\n \"\",\n \"\"\n ]\n },\n \"display_name\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"imported_count\": \"\",\n \"legal_entity\": {\n \"name\": \"\",\n \"slug\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4f7f221d-3e89-4cac-87f0-4a80656b7dc9" }, { "id": "7061500d-e09b-41ec-af9b-c62ef0bb3f5d", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7061500d-e09b-41ec-af9b-c62ef0bb3f5d" }, { "id": "79a0f1ce-5ed2-4ad8-adfe-d7c913ad0c97", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-79a0f1ce-5ed2-4ad8-adfe-d7c913ad0c97" }, { "id": "e4f51d3c-8f4c-4cfe-9ec9-b0f2dc6c6817", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e4f51d3c-8f4c-4cfe-9ec9-b0f2dc6c6817" }, { "id": "314c4669-e109-4524-be56-5188028d8ce6", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-314c4669-e109-4524-be56-5188028d8ce6" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7100758b-3a7b-4705-a7f2-c56e698db566" } ], "id": "b6233121-6483-4c3a-b557-7038979e15f1", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-b6233121-6483-4c3a-b557-7038979e15f1" }, { "name": "Create bulk employment job", "id": "3e0e3476-febb-49e3-8c55-68cb0c58c467", "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 \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] }, "description": "Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "61c656b1-8bd0-47fc-8b37-5e648a21c3ba", "name": "Accepted", "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 \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"stage\": \"creation\",\n \"status\": \"in_progress\",\n \"name\": \"\",\n \"total_count\": \"\",\n \"processed_count\": \"\",\n \"failed_count\": \"\",\n \"inserted_at\": \"\",\n \"inserted_by\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"personal_details\": {\n \"birthdate\": \"\",\n \"full_preferred_name\": \"\",\n \"gender\": \"\",\n \"gender_description\": \"\",\n \"given_name\": \"\",\n \"is_us_person\": \"\",\n \"mobile_number\": \"\",\n \"nationality\": [\n \"\",\n \"\"\n ],\n \"preferred_name\": \"\",\n \"preferred_pronouns\": \"\",\n \"recovery_number\": \"\",\n \"redacted_fields\": [\n \"\",\n \"\"\n ],\n \"sex\": \"\",\n \"surname\": \"\",\n \"title\": \"mrs\"\n },\n \"profile_picture\": \"\",\n \"status\": \"deleted\"\n },\n \"updated_at\": \"\",\n \"finished_at\": \"\",\n \"metadata\": {},\n \"column_mapping\": {\n \"mapping\": {},\n \"source_columns\": [\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n },\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n }\n ],\n \"unmapped_column_count\": \"\",\n \"unmapped_required_field_count\": \"\",\n \"auto_mapped_columns\": [\n \"\",\n \"\"\n ]\n },\n \"display_name\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"imported_count\": \"\",\n \"legal_entity\": {\n \"name\": \"\",\n \"slug\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-61c656b1-8bd0-47fc-8b37-5e648a21c3ba" }, { "id": "7362646a-859e-4ce2-9d35-7168563948d9", "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 \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7362646a-859e-4ce2-9d35-7168563948d9" }, { "id": "ca75a321-edfc-420b-93e1-f417301dae15", "name": "Forbidden", "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 \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-ca75a321-edfc-420b-93e1-f417301dae15" }, { "id": "a92c02c3-b54a-41ce-89ab-225b902cd929", "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 \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-a92c02c3-b54a-41ce-89ab-225b902cd929" }, { "id": "6d572da8-381f-44a5-9cd4-94598225cf19", "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 \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6d572da8-381f-44a5-9cd4-94598225cf19" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-3e0e3476-febb-49e3-8c55-68cb0c58c467" } ], "id": "e0fdd3a1-9583-4192-8c77-a7d7ca541eb2", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-e0fdd3a1-9583-4192-8c77-a7d7ca541eb2" }, { "name": "ready", "item": [ { "name": "Complete onboarding", "id": "26d39fca-243b-496f-9c8b-b17c46b5c2ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] }, "description": "Completes the employee onboarding. When all tasks are completed, the employee is marked as in `review` status" }, "response": [ { "id": "54990fe8-64e0-4cf8-8a66-212d11553078", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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 \"cor\",\n \"cor\"\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\": \"employee\",\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\": \"completed\"\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\": \"pending\"\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\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"deleted\",\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\": \"plus\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\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\": \"created\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-54990fe8-64e0-4cf8-8a66-212d11553078" }, { "id": "68f014d5-4a88-42c6-b855-91cb463e154c", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-68f014d5-4a88-42c6-b855-91cb463e154c" }, { "id": "db12a75a-62c5-4254-9a67-b0da583b33b8", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-db12a75a-62c5-4254-9a67-b0da583b33b8" }, { "id": "124cb857-f061-48ba-a2d4-13c2e51cc53b", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-124cb857-f061-48ba-a2d4-13c2e51cc53b" }, { "id": "4a652f97-82df-4a39-95a3-9ba4c10aa6a0", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-4a652f97-82df-4a39-95a3-9ba4c10aa6a0" }, { "id": "6df67564-7f8e-499a-8ffc-9c02190c537a", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-6df67564-7f8e-499a-8ffc-9c02190c537a" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-26d39fca-243b-496f-9c8b-b17c46b5c2ee" } ], "id": "d349165a-dbf1-42f4-a427-a448bd86324f", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d349165a-dbf1-42f4-a427-a448bd86324f" }, { "name": "documents", "item": [ { "name": "Upload file", "id": "fbd356f5-5541-4cdc-8aae-84e481c324ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file", "value": null }, { "description": "(Required) The unique identifier (UUID) of the employment to attach this file to.", "key": "employment_id", "value": "", "type": "text" }, { "description": "A more specific classification within the type (e.g., \"ir_35\" for a UK contractor tax determination).", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"contract\", \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents" ] }, "description": "Uploads a file associated with a specified employment.\n\nPlease contact api-support@remote.com to request access to this endpoint.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) |\n" }, "response": [ { "id": "7b8c8380-3dae-49ac-804e-29661b5bad96", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "(Required) The unique identifier (UUID) of the employment to attach this file to.", "key": "employment_id", "value": "", "type": "text" }, { "description": "A more specific classification within the type (e.g., \"ir_35\" for a UK contractor tax determination).", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"contract\", \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"file\": {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-7b8c8380-3dae-49ac-804e-29661b5bad96" }, { "id": "f8a13395-c738-4dda-b859-7b84fe79e093", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "(Required) The unique identifier (UUID) of the employment to attach this file to.", "key": "employment_id", "value": "", "type": "text" }, { "description": "A more specific classification within the type (e.g., \"ir_35\" for a UK contractor tax determination).", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"contract\", \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-f8a13395-c738-4dda-b859-7b84fe79e093" }, { "id": "002e7cd4-c2d5-4e88-8dc4-3803417e6b79", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "(Required) The unique identifier (UUID) of the employment to attach this file to.", "key": "employment_id", "value": "", "type": "text" }, { "description": "A more specific classification within the type (e.g., \"ir_35\" for a UK contractor tax determination).", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"contract\", \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-002e7cd4-c2d5-4e88-8dc4-3803417e6b79" }, { "id": "882accee-e060-4ba6-9f73-86490267fe3b", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file content, base64-encoded.", "key": "file", "type": "file" }, { "description": "(Required) The unique identifier (UUID) of the employment to attach this file to.", "key": "employment_id", "value": "", "type": "text" }, { "description": "A more specific classification within the type (e.g., \"ir_35\" for a UK contractor tax determination).", "key": "sub_type", "value": "", "type": "text" }, { "description": "The broad category of the file (e.g., \"contract\", \"id\", \"tax_form\").", "key": "type", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/documents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents" ] } }, "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:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-882accee-e060-4ba6-9f73-86490267fe3b" } ], "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-fbd356f5-5541-4cdc-8aae-84e481c324ab" } ], "id": "c873c05d-108b-446e-ad92-734861d982a2", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-c873c05d-108b-446e-ad92-734861d982a2" } ], "id": "d4b08d8b-5388-409b-bddc-e7c934babd5e", "createdAt": "2026-07-28T02:46:02.000Z", "updatedAt": "2026-07-28T02:46:02.000Z", "uid": "35240-d4b08d8b-5388-409b-bddc-e7c934babd5e" } ], "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/" } ] }