{ "info": { "_postman_id": "ffd17f15-ac2f-4dd7-b373-d831257c51e5", "name": "Remote Address Details Countries API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-ffd17f15-ac2f-4dd7-b373-d831257c51e5" }, "item": [ { "name": "v1", "item": [ { "name": "countries", "item": [ { "name": "{country_code}", "item": [ { "name": "contractor-contract-details", "item": [ { "name": "Show contractor contract details", "id": "2b945f27-0730-4bb9-ae6d-af1d34bef857", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "id": "fe26e9b6-aa67-4575-b330-30668a19d2a4", "key": "country_code", "value": "", "description": "(Required) Country code according to ISO 3-digit alphabetic codes" } ] }, "description": "Returns the contract details JSON Schema for contractors given a country\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View forms (`form:read`) | - |\n" }, "response": [ { "id": "737e226e-842a-4acb-a99b-e3dd879b7220", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"version\": \"\",\n \"schema\": {\n \"sunte60\": true,\n \"aute_7\": false\n }\n }\n}", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-737e226e-842a-4acb-a99b-e3dd879b7220" }, { "id": "47b91458-f930-4dce-8963-20db5ba8099c", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-47b91458-f930-4dce-8963-20db5ba8099c" }, { "id": "13c0b33e-1c1e-41ee-81e3-0c2aacafe638", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-13c0b33e-1c1e-41ee-81e3-0c2aacafe638" }, { "id": "faf1f1fb-2ba4-45a9-a496-bf739ebf472d", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-faf1f1fb-2ba4-45a9-a496-bf739ebf472d" }, { "id": "00e5a472-3b3c-4b70-bb4f-77bb5a4959e1", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-00e5a472-3b3c-4b70-bb4f-77bb5a4959e1" }, { "id": "8ae45dad-4fe0-4e0b-ad99-a83ddde413df", "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/countries/:country_code/contractor-contract-details?employment_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "contractor-contract-details" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-8ae45dad-4fe0-4e0b-ad99-a83ddde413df" } ], "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-2b945f27-0730-4bb9-ae6d-af1d34bef857" } ], "id": "ebe98ea1-b6d7-4d35-bc9b-63cce730daf8", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-ebe98ea1-b6d7-4d35-bc9b-63cce730daf8" }, { "name": "holidays", "item": [ { "name": "{year}", "item": [ { "name": "List all holidays of a country", "id": "41eb8213-9ff2-4e25-b9ad-713ea9a99ebc", "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/countries/:country_code/holidays/:year?country_subdivision_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "holidays", ":year" ], "query": [ { "description": "Country subdivision code according to ISO 3166-2 codes", "key": "country_subdivision_code", "value": "" } ], "variable": [ { "id": "55001b90-6d8b-4dd5-8eb0-2bbdf30e6597", "key": "country_code", "value": "", "description": "(Required) Country code according to ISO 3166-1 3-digit alphabetic codes" }, { "id": "e3f9b799-3ae0-4434-ba47-18c250ed58f7", "key": "year", "value": "", "description": "(Required) Year for the holidays" } ] }, "description": "List all holidays of a country for a specific year. Optionally, it can be filtered by country subdivision.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View countries (`country:read`) | - |\n" }, "response": [ { "id": "be9994c5-5b15-4db2-bd06-5486de489b76", "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/countries/:country_code/holidays/:year?country_subdivision_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "holidays", ":year" ], "query": [ { "description": "Country subdivision code according to ISO 3166-2 codes", "key": "country_subdivision_code", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "year" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"day\": \"\",\n \"note\": \"\",\n \"observed_day\": \"\"\n },\n {\n \"name\": \"\",\n \"day\": \"\",\n \"note\": \"\",\n \"observed_day\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-be9994c5-5b15-4db2-bd06-5486de489b76" }, { "id": "9afbdbc1-ed0d-4490-a958-b2d77decd76f", "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/countries/:country_code/holidays/:year?country_subdivision_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "holidays", ":year" ], "query": [ { "description": "Country subdivision code according to ISO 3166-2 codes", "key": "country_subdivision_code", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "year" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-9afbdbc1-ed0d-4490-a958-b2d77decd76f" }, { "id": "bcf7bf20-e1d3-409d-b74f-28fd214d552f", "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/countries/:country_code/holidays/:year?country_subdivision_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "holidays", ":year" ], "query": [ { "description": "Country subdivision code according to ISO 3166-2 codes", "key": "country_subdivision_code", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "year" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-bcf7bf20-e1d3-409d-b74f-28fd214d552f" }, { "id": "76c4ae6c-6388-47f8-8373-7d207b4949df", "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/countries/:country_code/holidays/:year?country_subdivision_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "holidays", ":year" ], "query": [ { "description": "Country subdivision code according to ISO 3166-2 codes", "key": "country_subdivision_code", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "year" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-76c4ae6c-6388-47f8-8373-7d207b4949df" } ], "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-41eb8213-9ff2-4e25-b9ad-713ea9a99ebc" } ], "id": "3fa7e1df-7e2b-4a2e-9f5f-c794e74147e0", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-3fa7e1df-7e2b-4a2e-9f5f-c794e74147e0" } ], "id": "fe95a32d-cf2a-4d32-af12-7399d3d53442", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-fe95a32d-cf2a-4d32-af12-7399d3d53442" }, { "name": "{form}", "item": [ { "name": "Show form schema", "id": "475079f8-8d15-40ee-8c57-bb9d0b60786a", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "id": "fb7d8dd8-84d2-4de1-a7ed-e70b0ed88468", "key": "country_code", "value": "", "description": "(Required) Country code according to ISO 3-digit alphabetic codes" }, { "id": "24d2832b-741c-4b02-a0ad-cdff29a6ef7a", "key": "form", "value": "", "description": "(Required) Name of the desired form" } ] }, "description": "Returns the json schema of a supported form. Possible form names are:\n```\n- address_details \n- administrative_details \n- bank_account_details \n- employment_basic_information \n- contractor_basic_information \n- contractor_contract_details \n- billing_address_details \n- contract_details \n- emergency_contact \n- emergency_contact_details \n- employment_document_details \n- personal_details \n- pricing_plan_details \n- company_basic_information \n- global_payroll_administrative_details \n- global_payroll_bank_account_details \n- global_payroll_basic_information \n- global_payroll_contract_details \n- global_payroll_federal_taxes \n- global_payroll_state_taxes \n- global_payroll_personal_details \n- benefit_renewal_request \n- hris_personal_details \n\n```\n\nMost forms require a company access token, as they are dependent on certain\nproperties of companies and their current employments. However, the `address_details`\nand `company_basic_information` forms can be accessed using client_credentials\nauthentication (without a company).\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View forms (`form:read`) | - |\n" }, "response": [ { "id": "dfa30e3c-c419-431a-bf49-9e60d50a388b", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-dfa30e3c-c419-431a-bf49-9e60d50a388b" }, { "id": "19d225f6-205b-4f54-85e0-3e27a634b465", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-19d225f6-205b-4f54-85e0-3e27a634b465" }, { "id": "18f49f50-1a61-4da2-98ad-24f250e8bc35", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-18f49f50-1a61-4da2-98ad-24f250e8bc35" }, { "id": "b1be57f6-dcd9-4e6a-9924-9b6354af9ada", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-b1be57f6-dcd9-4e6a-9924-9b6354af9ada" }, { "id": "c992df85-af34-4fc1-a9eb-c4608d42cd69", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-c992df85-af34-4fc1-a9eb-c4608d42cd69" }, { "id": "37ec2f0a-db94-4373-9c60-3ff15b9e7be3", "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/countries/:country_code/:form?employment_id=&jurisdiction=&only_for_testing_include_scheduled_benefit_groups=&skip_benefits=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", ":form" ], "query": [ { "description": "Required for `contract_amendment` and `global_payroll_state_taxes` forms", "key": "employment_id", "value": "" }, { "description": "Two-letter US state code. Required for `global_payroll_state_taxes` (e.g. `NY`).", "key": "jurisdiction", "value": "" }, { "description": "FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.", "key": "only_for_testing_include_scheduled_benefit_groups", "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": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-37ec2f0a-db94-4373-9c60-3ff15b9e7be3" } ], "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-475079f8-8d15-40ee-8c57-bb9d0b60786a" } ], "id": "35a5cb3b-62ee-4333-963f-6d04b1679664", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-35a5cb3b-62ee-4333-963f-6d04b1679664" }, { "name": "engagement-agreement-details", "item": [ { "name": "Show engagement agreement details", "id": "564e177d-56b7-4bdf-8285-2771a96ea360", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "id": "5e73ccdf-4e62-4270-866d-57c7117988fb", "key": "country_code", "value": "", "description": "(Required) Country code according to ISO 3-digit alphabetic codes" } ] }, "description": "Returns the engagement agreement details JSON Schema for a country. Only DEU country is supported for now.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View forms (`form:read`) | - |\n" }, "response": [ { "id": "59d41d66-1842-4403-8be4-8a66cb5e3bd9", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "key": "country_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"version\": \"\",\n \"schema\": {\n \"laborum71\": \"exercitation dolore deserunt\",\n \"velit_1\": \"culpa magna\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-59d41d66-1842-4403-8be4-8a66cb5e3bd9" }, { "id": "35705835-0400-47f4-b093-28f87ddfd3a8", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-35705835-0400-47f4-b093-28f87ddfd3a8" }, { "id": "046a1ed2-8ca9-40cb-8663-019636433cad", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-046a1ed2-8ca9-40cb-8663-019636433cad" }, { "id": "c0becae0-4602-499d-8bec-ca48d955f02a", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-c0becae0-4602-499d-8bec-ca48d955f02a" }, { "id": "46517606-5cd2-471a-8458-f1319ad4e88c", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-46517606-5cd2-471a-8458-f1319ad4e88c" }, { "id": "d49062aa-b33b-44a0-b46b-ba558a107c0b", "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/countries/:country_code/engagement-agreement-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "engagement-agreement-details" ], "variable": [ { "key": "country_code" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-d49062aa-b33b-44a0-b46b-ba558a107c0b" } ], "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-564e177d-56b7-4bdf-8285-2771a96ea360" } ], "id": "00826480-c63a-4bf0-b7d6-c3403ae00a82", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-00826480-c63a-4bf0-b7d6-c3403ae00a82" }, { "name": "legal_entity_forms", "item": [ { "name": "{form}", "item": [ { "name": "Show legal entity administrative details form schema", "id": "133f4dd5-45c9-4725-856a-919c3219b25c", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "id": "d14ba7b5-d8a5-40b9-8d76-0fe1d7d21223", "key": "country_code", "value": "", "description": "(Required) Country code according to ISO 3-digit alphabetic codes" }, { "id": "e8413585-e766-4350-bfc1-1ae05121aa27", "key": "form", "value": "", "description": "(Required) Name of the desired form" } ] }, "description": "Returns the json schema of a supported form. Possible form names are:\n```\n- administrative_details\n```\n\nMost forms require a company access token, as they are dependent on certain\nproperties of companies and their current employments.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View forms (`form:read`) | - |\n" }, "response": [ { "id": "fad10368-8163-4c29-a044-cf2819970a44", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-fad10368-8163-4c29-a044-cf2819970a44" }, { "id": "d2d26ff7-bdb9-4fb4-a667-8f56bce04d73", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-d2d26ff7-bdb9-4fb4-a667-8f56bce04d73" }, { "id": "5e3d24f0-46d1-43c0-ab18-0992d07709a4", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-5e3d24f0-46d1-43c0-ab18-0992d07709a4" }, { "id": "3e824f24-3fa1-46cc-bfc4-904a2006fe20", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-3e824f24-3fa1-46cc-bfc4-904a2006fe20" }, { "id": "bdcc289d-2431-431a-b699-c4f7245e5a56", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-bdcc289d-2431-431a-b699-c4f7245e5a56" }, { "id": "f09bd334-d05a-4bf1-8f1e-55920a2c8916", "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/countries/:country_code/legal_entity_forms/:form?product_type=global_payroll&legal_entity_id=&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries", ":country_code", "legal_entity_forms", ":form" ], "query": [ { "description": "Product type. Default value is global_payroll.", "key": "product_type", "value": "global_payroll" }, { "description": "Legal entity id for admistrative_details of e2e payroll products in GBR", "key": "legal_entity_id", "value": "" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ], "variable": [ { "key": "country_code" }, { "key": "form" } ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-f09bd334-d05a-4bf1-8f1e-55920a2c8916" } ], "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-133f4dd5-45c9-4725-856a-919c3219b25c" } ], "id": "31b6ffbf-e315-4ef8-864c-0b2f6e3fddc7", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-31b6ffbf-e315-4ef8-864c-0b2f6e3fddc7" } ], "id": "e2618f77-6e58-466a-9641-4e5210367d23", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-e2618f77-6e58-466a-9641-4e5210367d23" } ], "id": "aabfa2b7-973d-4778-8614-f09d346aa819", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-aabfa2b7-973d-4778-8614-f09d346aa819" }, { "name": "List countries", "id": "9334081e-2c67-4f7f-8c69-f5769deb8b0e", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] }, "description": "Returns a list of all countries that are supported by Remote API alphabetically ordered.\nThe supported list accounts for creating employment with basic information and it does not imply fully onboarding employment via JSON Schema.\nThe countries present in the list are the ones where creating a company is allowed.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View countries (`country:read`) | - |\n" }, "response": [ { "id": "f16a9009-5bc7-4d56-9570-c14060c8ebf4", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\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 {\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 ]\n}", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-f16a9009-5bc7-4d56-9570-c14060c8ebf4" }, { "id": "91027c74-0080-4131-8cc8-0f6acbab4171", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-91027c74-0080-4131-8cc8-0f6acbab4171" }, { "id": "ec4c95bc-1c1d-4d04-8af9-2e88cbb2dd33", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-ec4c95bc-1c1d-4d04-8af9-2e88cbb2dd33" }, { "id": "8285ba7a-8a99-4392-b4f2-35b34e7d5ae8", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-8285ba7a-8a99-4392-b4f2-35b34e7d5ae8" }, { "id": "cd6f8c5e-310b-4666-b7b5-862a68a57a17", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-cd6f8c5e-310b-4666-b7b5-862a68a57a17" }, { "id": "6d221c3f-b82f-4be0-a710-722e51bcc78e", "name": "Too many requests", "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/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "countries" ] } }, "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:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-6d221c3f-b82f-4be0-a710-722e51bcc78e" } ], "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-9334081e-2c67-4f7f-8c69-f5769deb8b0e" } ], "id": "7123323f-f62c-4238-a24e-03774e94ca68", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-7123323f-f62c-4238-a24e-03774e94ca68" } ], "id": "807f5f27-0b04-47fe-99a9-b7b37edd2da2", "createdAt": "2026-07-28T02:45:22.000Z", "updatedAt": "2026-07-28T02:45:22.000Z", "uid": "35240-807f5f27-0b04-47fe-99a9-b7b37edd2da2" } ], "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/" } ] }