{ "info": { "_postman_id": "b6b22525-3201-43bf-98ad-482870807c1f", "name": "Remote Address Details Eligibility API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:32.000Z", "updatedAt": "2026-07-28T02:45:32.000Z", "lastUpdatedBy": "35240", "uid": "35240-b6b22525-3201-43bf-98ad-482870807c1f" }, "item": [ { "name": "v1", "item": [ { "name": "contractors", "item": [ { "name": "eligibility-questionnaire", "item": [ { "name": "Submit eligibility questionnaire", "id": "453d866c-5dc8-4e94-82b3-9b07878dd8dd", "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 \"type\": \"contractor_of_record\",\n \"responses\": {\n \"enim_129\": \"\",\n \"ametcaa\": \"\",\n \"culpa9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contractors/eligibility-questionnaire?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "eligibility-questionnaire" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Submits an eligibility questionnaire for a contractor employment.\n\nThe questionnaire determines if the contractor is eligible for certain products or features.\nThe responses are validated against the JSON schema for the questionnaire type.\n\n**Requirements:**\n- Employment must be of type `contractor`\n- Employment must be in `created` status\n- Responses must conform to the questionnaire JSON schema\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": "2d73d4c0-ef1c-4f75-b374-5910de955b31", "name": "Questionnaire submitted successfully", "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 \"type\": \"contractor_of_record\",\n \"responses\": {\n \"enim_129\": \"\",\n \"ametcaa\": \"\",\n \"culpa9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contractors/eligibility-questionnaire?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "eligibility-questionnaire" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"slug\": \"\",\n \"is_blocking\": \"\",\n \"type\": \"contractor_of_record\",\n \"submitted_at\": \"\",\n \"questions\": {},\n \"responses\": {}\n }\n}", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-2d73d4c0-ef1c-4f75-b374-5910de955b31" }, { "id": "fbcb797f-0335-4b9d-955c-34bee20aed82", "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 \"type\": \"contractor_of_record\",\n \"responses\": {\n \"enim_129\": \"\",\n \"ametcaa\": \"\",\n \"culpa9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contractors/eligibility-questionnaire?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "eligibility-questionnaire" ], "query": [ { "description": "Version of the form schema", "key": "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:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-fbcb797f-0335-4b9d-955c-34bee20aed82" }, { "id": "9db577e2-95a2-4923-8db9-a1494e0b44d6", "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 \"employment_slug\": \"\",\n \"type\": \"contractor_of_record\",\n \"responses\": {\n \"enim_129\": \"\",\n \"ametcaa\": \"\",\n \"culpa9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contractors/eligibility-questionnaire?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "eligibility-questionnaire" ], "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:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-9db577e2-95a2-4923-8db9-a1494e0b44d6" }, { "id": "356b2896-0d09-45f1-b3f5-b199eea19608", "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 \"employment_slug\": \"\",\n \"type\": \"contractor_of_record\",\n \"responses\": {\n \"enim_129\": \"\",\n \"ametcaa\": \"\",\n \"culpa9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contractors/eligibility-questionnaire?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "eligibility-questionnaire" ], "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 \"errors\": {\n \"enim_01\": true,\n \"doa\": false\n }\n}", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-356b2896-0d09-45f1-b3f5-b199eea19608" }, { "id": "e4fa7fed-59ea-4dbf-a2c3-b5796c3d0479", "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 \"type\": \"contractor_of_record\",\n \"responses\": {\n \"enim_129\": \"\",\n \"ametcaa\": \"\",\n \"culpa9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contractors/eligibility-questionnaire?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "eligibility-questionnaire" ], "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:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-e4fa7fed-59ea-4dbf-a2c3-b5796c3d0479" } ], "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-453d866c-5dc8-4e94-82b3-9b07878dd8dd" } ], "id": "b9320cbe-18c7-4ea4-bbb5-6989166ac5f8", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-b9320cbe-18c7-4ea4-bbb5-6989166ac5f8" }, { "name": "schemas", "item": [ { "name": "eligibility-questionnaire", "item": [ { "name": "Get eligibility questionnaire schema", "id": "d90df4df-91b7-4840-a58c-2b201d9a0366", "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/contractors/schemas/eligibility-questionnaire?type=contractor_of_record&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "schemas", "eligibility-questionnaire" ], "query": [ { "description": "(Required) Type of eligibility questionnaire", "key": "type", "value": "contractor_of_record" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Returns the JSON schema for the eligibility questionnaire by type.\n\nThe schema defines the structure and validation rules for the questionnaire responses.\nSupports versioning to allow for schema evolution while maintaining backwards compatibility.\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": "1fd89df1-5b86-4bab-b6b4-411ebfdb48fb", "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/contractors/schemas/eligibility-questionnaire?type=contractor_of_record&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "schemas", "eligibility-questionnaire" ], "query": [ { "description": "(Required) Type of eligibility questionnaire", "key": "type", "value": "contractor_of_record" }, { "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 \"permissions\": {},\n \"schema\": {},\n \"version\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-1fd89df1-5b86-4bab-b6b4-411ebfdb48fb" }, { "id": "b191b12e-ed2d-41b2-8793-8b347c346448", "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/contractors/schemas/eligibility-questionnaire?type=contractor_of_record&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "schemas", "eligibility-questionnaire" ], "query": [ { "description": "(Required) Type of eligibility questionnaire", "key": "type", "value": "contractor_of_record" }, { "description": "Version of the form schema", "key": "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:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-b191b12e-ed2d-41b2-8793-8b347c346448" }, { "id": "628ff45d-e5bc-4db7-8996-d5b295788fbf", "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/contractors/schemas/eligibility-questionnaire?type=contractor_of_record&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "schemas", "eligibility-questionnaire" ], "query": [ { "description": "(Required) Type of eligibility questionnaire", "key": "type", "value": "contractor_of_record" }, { "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:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-628ff45d-e5bc-4db7-8996-d5b295788fbf" }, { "id": "2c462b44-6318-4702-818f-6faa25433d79", "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/contractors/schemas/eligibility-questionnaire?type=contractor_of_record&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contractors", "schemas", "eligibility-questionnaire" ], "query": [ { "description": "(Required) Type of eligibility questionnaire", "key": "type", "value": "contractor_of_record" }, { "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:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-2c462b44-6318-4702-818f-6faa25433d79" } ], "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-d90df4df-91b7-4840-a58c-2b201d9a0366" } ], "id": "f9a418c9-eae1-4ccf-a629-34dc09914b93", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-f9a418c9-eae1-4ccf-a629-34dc09914b93" } ], "id": "a6e6ae9c-7019-4fb9-9a56-ddb891e615e3", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-a6e6ae9c-7019-4fb9-9a56-ddb891e615e3" } ], "id": "3227fc66-68ec-4804-aedc-37a183723e05", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-3227fc66-68ec-4804-aedc-37a183723e05" } ], "id": "962e2458-fcbb-48a6-864d-a4b2c1a0d778", "createdAt": "2026-07-28T02:45:33.000Z", "updatedAt": "2026-07-28T02:45:33.000Z", "uid": "35240-962e2458-fcbb-48a6-864d-a4b2c1a0d778" } ], "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/" } ] }