{ "info": { "_postman_id": "03cf4572-b6d7-4388-ba78-f61bcc1b8288", "name": "Remote Address Details Pre-Onboarding Requirements API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "lastUpdatedBy": "35240", "uid": "35240-03cf4572-b6d7-4388-ba78-f61bcc1b8288" }, "item": [ { "name": "v1", "item": [ { "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": "0e5e5afe-874f-4c73-94ef-5155185fb50a", "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": "0aa98515-47ee-4df3-a337-fecda4990331", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "b48a2e40-e68e-41aa-97b4-0434c297ef44", "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": "3bf23fec-1936-4e10-b081-6aec05ebceb1", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-3bf23fec-1936-4e10-b081-6aec05ebceb1" }, { "id": "58c6ab3c-a97b-46ed-9032-36acb0c0fceb", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-58c6ab3c-a97b-46ed-9032-36acb0c0fceb" }, { "id": "5e0cf08d-ed27-498e-b3f2-3db1326d95ac", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-5e0cf08d-ed27-498e-b3f2-3db1326d95ac" }, { "id": "a1db2656-f5f5-443f-b404-4fac2da81e8f", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-a1db2656-f5f5-443f-b404-4fac2da81e8f" }, { "id": "9db31808-959a-4613-9671-5ac3bb9d64a4", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-9db31808-959a-4613-9671-5ac3bb9d64a4" } ], "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-0e5e5afe-874f-4c73-94ef-5155185fb50a" }, { "name": "Acknowledge a pre-onboarding acknowledgement requirement", "id": "68c0bfbd-fa2d-47c5-b9d8-7dc8d5a785b4", "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": "f5cce95f-0821-403f-a406-d07be9cc7b89", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "ec6fb9f3-d33e-4f3d-83b6-20f4908b046d", "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": "38a0b699-0c37-45f0-aadc-ac291a5922bf", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-38a0b699-0c37-45f0-aadc-ac291a5922bf" }, { "id": "c99dcb41-e75b-42b2-a605-b73c2ed30eed", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-c99dcb41-e75b-42b2-a605-b73c2ed30eed" }, { "id": "5c911be4-ccfb-48cf-9487-77f2ff97d90e", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-5c911be4-ccfb-48cf-9487-77f2ff97d90e" }, { "id": "a9cc543b-1fa4-484a-9680-1f9d5d143902", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-a9cc543b-1fa4-484a-9680-1f9d5d143902" }, { "id": "90f68a13-08bf-425a-9b72-a97dc3f21259", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-90f68a13-08bf-425a-9b72-a97dc3f21259" } ], "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-68c0bfbd-fa2d-47c5-b9d8-7dc8d5a785b4" } ], "id": "c4983344-51b0-4fa6-a94e-179c6609b91e", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-c4983344-51b0-4fa6-a94e-179c6609b91e" }, { "name": "documents", "item": [ { "name": "Find or create a document for a pre-onboarding requirement", "id": "3a502213-0669-4648-8dcb-f30d9e8ba2b9", "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": "0f855446-3def-4742-815c-3f6ddbff791a", "key": "employment_id", "value": "", "description": "(Required) Employment ID" }, { "id": "8f9e82d7-d87e-40bb-8598-33b76fbd7ec0", "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": "55ddf039-ed69-4f53-bf76-6ccfb9ad6018", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-55ddf039-ed69-4f53-bf76-6ccfb9ad6018" }, { "id": "2b76e024-f4a0-4065-ba29-266afe4e3177", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-2b76e024-f4a0-4065-ba29-266afe4e3177" }, { "id": "3a926867-0105-47c7-afd3-3dddd3ede13f", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-3a926867-0105-47c7-afd3-3dddd3ede13f" }, { "id": "a8556d0c-a10e-4977-89ff-fc8e399936bf", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-a8556d0c-a10e-4977-89ff-fc8e399936bf" }, { "id": "3b76192c-5873-4081-b823-639e7f8a238a", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-3b76192c-5873-4081-b823-639e7f8a238a" } ], "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-3a502213-0669-4648-8dcb-f30d9e8ba2b9" } ], "id": "0adeb3ef-533b-4a12-8991-5463c7f69be7", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-0adeb3ef-533b-4a12-8991-5463c7f69be7" } ], "id": "7cbb2fa1-5211-4ef9-bce1-c0799e5c41bd", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-7cbb2fa1-5211-4ef9-bce1-c0799e5c41bd" }, { "name": "List pre-onboarding requirements for an employment", "id": "ca09eb44-17fa-47f3-9f26-43f145fe36c6", "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": "1f038199-0d1d-483f-941f-1ceed5eb97b4", "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": "4f0ac462-3f4f-45a3-8989-75c4a6495d15", "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\": \"awaiting\",\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\": \"blocked\",\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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-4f0ac462-3f4f-45a3-8989-75c4a6495d15" }, { "id": "63faa54f-07f2-4ad1-a80c-96d9d7070619", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-63faa54f-07f2-4ad1-a80c-96d9d7070619" }, { "id": "31edb392-d955-4e97-8d1c-792a74306183", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-31edb392-d955-4e97-8d1c-792a74306183" }, { "id": "24e30324-fa32-416d-9b01-eb20ffc7ebc9", "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:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-24e30324-fa32-416d-9b01-eb20ffc7ebc9" } ], "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-ca09eb44-17fa-47f3-9f26-43f145fe36c6" } ], "id": "42bb75e0-4783-491e-bfe6-926f1f06c957", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-42bb75e0-4783-491e-bfe6-926f1f06c957" } ], "id": "6c1bacde-03ea-4151-b41b-8f69ed912a47", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-6c1bacde-03ea-4151-b41b-8f69ed912a47" } ], "id": "198f59e2-8994-410d-aedd-83439358252a", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-198f59e2-8994-410d-aedd-83439358252a" } ], "id": "f009cc12-59f3-423d-95fc-6436fbf9caca", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-f009cc12-59f3-423d-95fc-6436fbf9caca" } ], "id": "0fb3338c-bdce-4bae-ae11-e9c550364a08", "createdAt": "2026-07-28T02:47:35.000Z", "updatedAt": "2026-07-28T02:47:35.000Z", "uid": "35240-0fb3338c-bdce-4bae-ae11-e9c550364a08" } ], "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/" } ] }