{ "item": [ { "id": "784180d5-c208-4767-ba2a-94090ba0e1c0", "name": "home", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "717a0c2c-d5c7-4eda-a5fd-5cd0e36dad8d", "name": "Fetch the homepage", "request": { "name": "Fetch the homepage", "description": { "content": "The SuperAPI application does not currently have a homepage, loading this will automatically issue a redirect header to the actual homepage.", "type": "text/plain" }, "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "auth": null }, "response": [ { "id": "916295d6-4465-4c10-88f4-0a59daacf95a", "name": "Redirect", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "body": {} }, "status": "Moved Permanently", "code": 301, "header": [ { "disabled": false, "description": "https://www.superapi.com.au", "key": "Location", "value": "" }, { "key": "Content-Type", "value": "text/html" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b8124a6-a69e-4773-a71d-2dbea8f7da7b", "name": "Load the swagger specs", "request": { "name": "Load the swagger specs", "description": { "content": "Our old swagger specs were hosted at this location and a number of inbound links still point to this URL. This route exists to redirect users to the new location of the swagger specs.", "type": "text/plain" }, "url": { "path": [ "swaggerui" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "auth": null }, "response": [ { "id": "e9a7ef02-7f75-46db-8841-b72be3fa98b7", "name": "Redirect", "originalRequest": { "url": { "path": [ "swaggerui" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "body": {} }, "status": "Moved Permanently", "code": 301, "header": [ { "disabled": false, "description": "https://swagger.superapi.com.au", "key": "Location", "value": "" }, { "key": "Content-Type", "value": "text/html" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b35dff57-40a7-4fbd-9e04-78457bf1f7d3", "name": "Load the swagger specs", "request": { "name": "Load the swagger specs", "description": { "content": "Our old swagger specs were hosted at this location and a number of inbound links still point to this URL. This route exists to redirect users to the new location of the swagger specs.", "type": "text/plain" }, "url": { "path": [ "swaggerui", "*path" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "auth": null }, "response": [ { "id": "8d26cdef-e585-40a2-869a-5ce7b5adf002", "name": "Redirect", "originalRequest": { "url": { "path": [ "swaggerui", "*path" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "body": {} }, "status": "Moved Permanently", "code": 301, "header": [ { "disabled": false, "description": "https://swagger.superapi.com.au", "key": "Location", "value": "" }, { "key": "Content-Type", "value": "text/html" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "899f5817-2f2d-417e-ab41-f209fb8f3adb", "name": "api-requests", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5c3c8360-c641-476f-bcd2-0e398ab994ae", "name": "List recent API requests", "request": { "name": "List recent API requests", "description": {}, "url": { "path": [ "api", "v1", "api-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Maximum number of records to return" }, { "disabled": false, "key": "offset", "value": "", "description": "Number of records to skip" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fbbf9a61-501c-43a7-b45a-eb0514cedb0d", "name": "API Requests", "originalRequest": { "url": { "path": [ "api", "v1", "api-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"host\": \"string\",\n \"method\": \"string\",\n \"scheme\": \"string\",\n \"port\": 9265,\n \"sentinel_request_id\": \"b595871b-c5c5-f5f2-cfd6-8863a604fc66\",\n \"sentinel_received_at\": \"1967-04-22T09:48:28.666Z\",\n \"request_headers\": {},\n \"request_cookies\": {},\n \"request_path\": \"string\",\n \"plug_request_id\": \"string\",\n \"api_key_short_token\": \"string\",\n \"id\": \"70dfa169-92bf-a7cd-48ac-82e83265ec4b\",\n \"inserted_at\": \"string\",\n \"params\": {},\n \"partner_id\": \"cbdd6067-ac8b-3543-5bf1-f5129683fd00\",\n \"path_info\": [\n \"string\",\n \"string\"\n ],\n \"path_params\": {},\n \"product_id\": \"4fe93f38-9d15-498e-50dc-e2d2453cc87c\",\n \"query_params\": {},\n \"query_string\": \"string\",\n \"remote_ip\": \"string\",\n \"response_body\": \"string\",\n \"response_cookies\": {},\n \"response_headers\": {},\n \"status\": 9360,\n \"updated_at\": \"string\"\n },\n {\n \"host\": \"string\",\n \"method\": \"string\",\n \"scheme\": \"string\",\n \"port\": 5509,\n \"sentinel_request_id\": \"e011bb6e-830f-1056-0ca3-ba6c490df21d\",\n \"sentinel_received_at\": \"1964-04-22T17:19:30.453Z\",\n \"request_headers\": {},\n \"request_cookies\": {},\n \"request_path\": \"string\",\n \"plug_request_id\": \"string\",\n \"api_key_short_token\": \"string\",\n \"id\": \"c1397961-d8fe-d52a-93fc-69b002505d5b\",\n \"inserted_at\": \"string\",\n \"params\": {},\n \"partner_id\": \"e2ffa9c6-74f0-3a62-6f3e-81c88d7843dc\",\n \"path_info\": [\n \"string\",\n \"string\"\n ],\n \"path_params\": {},\n \"product_id\": \"98ae9241-4359-bf3a-2e3a-aa3843f6379b\",\n \"query_params\": {},\n \"query_string\": \"string\",\n \"remote_ip\": \"string\",\n \"response_body\": \"string\",\n \"response_cookies\": {},\n \"response_headers\": {},\n \"status\": 9823,\n \"updated_at\": \"string\"\n }\n ],\n \"offset\": 3514\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "17ec12d1-229e-405f-b3ae-df5fc5cce33f", "name": "employee", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "21bd0115-d024-431a-b2b4-96f3d3e4e63f", "name": "List onboarding sessions for an employee", "request": { "name": "List onboarding sessions for an employee", "description": { "content": "List onboarding sessions associated with the specified employee.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employee", ":employee_id", "onboarding-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "The page number for pagination, can not be a negative number or 0, Defaults to 1" }, { "disabled": false, "key": "sort_by", "value": "", "description": "The field to sort by, must be one of `updated_at`. Defaults to `updated_at`" }, { "disabled": false, "key": "sort_order", "value": "", "description": "The sort order (`asc` or `desc`). Defaults to `desc`" }, { "disabled": false, "key": "limit", "value": "", "description": "The number of records to return per page, must be between 1 and 50. Defaults to 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The primary key of the employee" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4f72172f-d18d-4f7b-8def-d1432f059fb5", "name": "List of onboarding sessions", "originalRequest": { "url": { "path": [ "api", "v1", "employee", ":employee_id", "onboarding-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "updated_at" }, { "key": "sort_order", "value": "desc" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The primary key of the employee" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"1234567890\",\n \"branch\": {\n \"address\": \"Miller & Mount Sts\",\n \"branch\": \"MLC Building Society (DES)\",\n \"bsb\": \"021111\",\n \"mnemonic\": \"NAB\",\n \"postcode\": \"2060\",\n \"state\": \"nsw\",\n \"suburb\": \"North Sydney\"\n },\n \"name\": \"John Doe 0\",\n \"rank\": 0,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 100\n }\n }\n ],\n \"outcome\": \"complete\"\n },\n \"data_delivery_state\": \"collect_super_details\",\n \"document_uploads\": null,\n \"email\": \"openspec+arpa@example.com\",\n \"email_validated\": true,\n \"employee\": {\n \"address\": null,\n \"employer\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"phone_numbers\": [\n {\n \"employee_provided_at\": null,\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"partner_provided_at\": null,\n \"phone_number\": \"+61443213211\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"verified_at\": \"2026-01-19T23:59:33Z\"\n }\n ],\n \"remote_id\": \"a0281b8f-bc9b-4b10-a5f7-530f1b16cd23\",\n \"super_fund_details\": {\n \"super_fund_memberships\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": null,\n \"work_condition\": null\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"confidence_score\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"address_line_3\": null,\n \"address_line_4\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"super_details\": {\n \"smsf\": null,\n \"super_funds\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": \"pending\",\n \"work_condition\": null\n }\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"email\": \"test@example.com\",\n \"locality\": \"West Footscray\",\n \"name\": \"Test Example\",\n \"phone_number\": \"+61412345678\",\n \"postcode\": \"3056\",\n \"relationship\": \"Friend\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"2000-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"gender_other\": null,\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\",\n \"title_other\": null\n },\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"2026-02-18T23:59:34Z\",\n \"fair_work_statements\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\",\n \"fixed_term_contract\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000//s3/path/to/openspec-form-document-response.pdf?response-content-disposition=attachment%3B%20filename%3DOpenspec%20Form%20Document%20%28Signed%29.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=b28a1cb1eb1a5530bed365584ccd105e3f63e764580c8c7f364809dd6b3061c5\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Form Document\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ],\n \"outcome\": \"complete\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"last_activity_at\": null,\n \"onboarding_session_super_selection\": {\n \"outcome\": \"incomplete\",\n \"progress_state\": \"select_member_details\",\n \"select_super_fund_product\": {\n \"is_default_selection\": false,\n \"member_number\": null,\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n }\n },\n \"self_managed_super_fund\": null,\n \"super_fund_member_detail\": null\n },\n \"phone_number\": \"+61443213211\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"outcome\": \"incomplete\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/policies-c62f31bb-4d41-44c7-821f-9ff23dd198fd.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d33839fc9a0a2be6788010a1ac33e179d055aab9e39bb2313ffb45e5f27e964c\",\n \"policy_acknowledgement_id\": \"8420a9e4-95e8-4938-b0bb-ef5644590ffe\"\n }\n ],\n \"outcome\": \"complete\",\n \"policy_acknowledgements\": [\n {\n \"acknowledged_at\": \"2026-01-31T12:00:00\",\n \"description\": \"This is a demo employer policy for Openspec.\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Employer Policy\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 1,\n \"is_abandoned\": false\n },\n \"remote_id\": \"37dd63d3-0460-44e4-9db8-a867fec380cc\",\n \"super_disclaimer\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\"\n },\n \"target_origin\": null,\n \"template_id\": \"f13afd01-245d-40b4-9144-8326c861d689\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"outcome\": \"complete\",\n \"tfn_declaration\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"country_of_origin\": null,\n \"country_of_origin_alpha_2\": null,\n \"country_of_origin_name\": null,\n \"date_of_birth\": \"1980-04-11\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": true,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"Richardson\",\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"given_name\": \"Sam\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"locality\": \"West Footscray\",\n \"middle_name\": null,\n \"pay_basis\": \"full_time\",\n \"postcode\": \"3056\",\n \"previous_family_name\": \"Cuming\",\n \"previous_given_name\": \"Samuel\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"state\": \"vic\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"049333118\",\n \"tfn_exemption_type\": null,\n \"title\": \"mr\"\n }\n }\n },\n {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"1234567890\",\n \"branch\": {\n \"address\": \"Miller & Mount Sts\",\n \"branch\": \"MLC Building Society (DES)\",\n \"bsb\": \"021111\",\n \"mnemonic\": \"NAB\",\n \"postcode\": \"2060\",\n \"state\": \"nsw\",\n \"suburb\": \"North Sydney\"\n },\n \"name\": \"John Doe 0\",\n \"rank\": 0,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 100\n }\n }\n ],\n \"outcome\": \"complete\"\n },\n \"data_delivery_state\": \"collect_super_details\",\n \"document_uploads\": null,\n \"email\": \"openspec+arpa@example.com\",\n \"email_validated\": true,\n \"employee\": {\n \"address\": null,\n \"employer\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"phone_numbers\": [\n {\n \"employee_provided_at\": null,\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"partner_provided_at\": null,\n \"phone_number\": \"+61443213211\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"verified_at\": \"2026-01-19T23:59:33Z\"\n }\n ],\n \"remote_id\": \"a0281b8f-bc9b-4b10-a5f7-530f1b16cd23\",\n \"super_fund_details\": {\n \"super_fund_memberships\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": null,\n \"work_condition\": null\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"confidence_score\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"address_line_3\": null,\n \"address_line_4\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"super_details\": {\n \"smsf\": null,\n \"super_funds\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": \"pending\",\n \"work_condition\": null\n }\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"email\": \"test@example.com\",\n \"locality\": \"West Footscray\",\n \"name\": \"Test Example\",\n \"phone_number\": \"+61412345678\",\n \"postcode\": \"3056\",\n \"relationship\": \"Friend\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"2000-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"gender_other\": null,\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\",\n \"title_other\": null\n },\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"2026-02-18T23:59:34Z\",\n \"fair_work_statements\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\",\n \"fixed_term_contract\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000//s3/path/to/openspec-form-document-response.pdf?response-content-disposition=attachment%3B%20filename%3DOpenspec%20Form%20Document%20%28Signed%29.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=b28a1cb1eb1a5530bed365584ccd105e3f63e764580c8c7f364809dd6b3061c5\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Form Document\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ],\n \"outcome\": \"complete\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"last_activity_at\": null,\n \"onboarding_session_super_selection\": {\n \"outcome\": \"incomplete\",\n \"progress_state\": \"select_member_details\",\n \"select_super_fund_product\": {\n \"is_default_selection\": false,\n \"member_number\": null,\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n }\n },\n \"self_managed_super_fund\": null,\n \"super_fund_member_detail\": null\n },\n \"phone_number\": \"+61443213211\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"outcome\": \"incomplete\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/policies-c62f31bb-4d41-44c7-821f-9ff23dd198fd.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d33839fc9a0a2be6788010a1ac33e179d055aab9e39bb2313ffb45e5f27e964c\",\n \"policy_acknowledgement_id\": \"8420a9e4-95e8-4938-b0bb-ef5644590ffe\"\n }\n ],\n \"outcome\": \"complete\",\n \"policy_acknowledgements\": [\n {\n \"acknowledged_at\": \"2026-01-31T12:00:00\",\n \"description\": \"This is a demo employer policy for Openspec.\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Employer Policy\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 1,\n \"is_abandoned\": false\n },\n \"remote_id\": \"37dd63d3-0460-44e4-9db8-a867fec380cc\",\n \"super_disclaimer\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\"\n },\n \"target_origin\": null,\n \"template_id\": \"f13afd01-245d-40b4-9144-8326c861d689\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"outcome\": \"complete\",\n \"tfn_declaration\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"country_of_origin\": null,\n \"country_of_origin_alpha_2\": null,\n \"country_of_origin_name\": null,\n \"date_of_birth\": \"1980-04-11\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": true,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"Richardson\",\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"given_name\": \"Sam\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"locality\": \"West Footscray\",\n \"middle_name\": null,\n \"pay_basis\": \"full_time\",\n \"postcode\": \"3056\",\n \"previous_family_name\": \"Cuming\",\n \"previous_given_name\": \"Samuel\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"state\": \"vic\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"049333118\",\n \"tfn_exemption_type\": null,\n \"title\": \"mr\"\n }\n }\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15ab3717-1053-4b2d-a653-be133f7425ed", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "employee", ":employee_id", "onboarding-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "updated_at" }, { "key": "sort_order", "value": "desc" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The primary key of the employee" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abea3a46-2882-41e8-be49-4e598868e848", "name": "Show an employee", "request": { "name": "Show an employee", "description": { "content": "Fetches an employee associated with the specified employer.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employee", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employee" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9b5beb07-98bf-46fb-ae0b-55535835b74e", "name": "Employee details", "originalRequest": { "url": { "path": [ "api", "v1", "employee", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employee" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"address_line_1\": {\n \"value\": \"\"\n },\n \"address_line_2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postcode\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": \"+61412312312\",\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": \"+61412312312\",\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"abn\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"kind\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n }\n },\n {\n \"abn\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"kind\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"tax_detail\": {\n \"id\": \"\",\n \"country_of_origin\": {\n \"value\": \"\"\n },\n \"employment_type\": {\n \"value\": \"\"\n },\n \"has_financial_supplement_debt\": true,\n \"has_study_and_training_repayment\": false,\n \"income_type\": {\n \"value\": \"\"\n },\n \"pay_basis\": {\n \"value\": \"\"\n },\n \"residency_type\": {\n \"value\": \"\"\n },\n \"senior_marital_status\": {\n \"value\": \"\"\n },\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": {\n \"value\": \"\"\n },\n \"tfn\": \"string\",\n \"tfn_exemption_type\": {\n \"value\": \"\"\n },\n \"work_condition\": {\n \"value\": \"\"\n }\n }\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdbccd26-f065-48ed-be60-7d5f7699f262", "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "employee", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employee" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e76ba21-0291-406f-be4d-1a831ae0afa9", "name": "Create a new employee", "request": { "name": "Create a new employee", "description": { "content": "Creates a new employee associated with the specified employer.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer", ":employer_id", "employee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"remote_id\": \"\",\n \"email\": \"\",\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"identity\": {\n \"date_of_birth\": \"\",\n \"family_name\": \"\",\n \"gender\": \"\",\n \"given_name\": \"\",\n \"middle_name\": \"\",\n \"previous_family_name\": \"\",\n \"previous_given_name\": \"\",\n \"title\": \"\"\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"\"\n },\n {\n \"phone_number\": \"\"\n }\n ],\n \"tax_details\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "58bceb25-6934-4c13-bf9d-d16560e544f4", "name": "Employee created", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"remote_id\": \"\",\n \"email\": \"test@example.com\",\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"+61412312312\"\n },\n {\n \"phone_number\": \"+61412312312\"\n }\n ],\n \"tax_details\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"address_line_1\": {\n \"value\": \"\"\n },\n \"address_line_2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postcode\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": \"+61412312312\",\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": \"+61412312312\",\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"abn\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"kind\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n }\n },\n {\n \"abn\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"kind\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"tax_detail\": {\n \"id\": \"\",\n \"country_of_origin\": {\n \"value\": \"\"\n },\n \"employment_type\": {\n \"value\": \"\"\n },\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"income_type\": {\n \"value\": \"\"\n },\n \"pay_basis\": {\n \"value\": \"\"\n },\n \"residency_type\": {\n \"value\": \"\"\n },\n \"senior_marital_status\": {\n \"value\": \"\"\n },\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": {\n \"value\": \"\"\n },\n \"tfn\": \"\",\n \"tfn_exemption_type\": {\n \"value\": \"\"\n },\n \"work_condition\": {\n \"value\": \"\"\n }\n }\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38e73ac6-e16b-47ca-ac5b-4a30621279f5", "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"remote_id\": \"\",\n \"email\": \"test@example.com\",\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"+61412312312\"\n },\n {\n \"phone_number\": \"+61412312312\"\n }\n ],\n \"tax_details\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a5dab38-aaf1-4e1b-9eed-a0842acafdfb", "name": "Unprocessible entity", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"remote_id\": \"\",\n \"email\": \"test@example.com\",\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"+61412312312\"\n },\n {\n \"phone_number\": \"+61412312312\"\n }\n ],\n \"tax_details\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d14bb7b8-4b02-4174-9369-bb33f854e1df", "name": "List employees for an employer", "request": { "name": "List employees for an employer", "description": { "content": "List employees for an employer", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "The page number for pagination, can not be a negative number or 0, Defaults to 1" }, { "disabled": false, "key": "sort_by", "value": "", "description": "The field to sort by, must be one of `given_name`, `family_name`, or `inserted_at`. Defaults to `inserted_at`" }, { "disabled": false, "key": "sort_order", "value": "", "description": "The sort order (`asc` or `desc`). Defaults to `asc`" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1be38349-deca-486f-b9ba-d443cd1d9151", "name": "Employee list", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "inserted_at" }, { "key": "sort_order", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"address_line_1\": {\n \"value\": \"\"\n },\n \"address_line_2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postcode\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n }\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"id\": {\n \"value\": \"\"\n },\n \"country_of_origin\": {\n \"value\": \"\"\n },\n \"employment_type\": {\n \"value\": \"\"\n },\n \"has_financial_supplement_debt\": {\n \"value\": \"\"\n },\n \"has_study_and_training_repayment\": {\n \"value\": \"\"\n },\n \"income_type\": {\n \"value\": \"\"\n },\n \"pay_basis\": {\n \"value\": \"\"\n },\n \"residency_type\": {\n \"value\": \"\"\n },\n \"senior_marital_status\": {\n \"value\": \"\"\n },\n \"tax_free_threshold_claimed\": {\n \"value\": \"\"\n },\n \"tax_scale_type\": {\n \"value\": \"\"\n },\n \"tfn\": {\n \"value\": \"\"\n },\n \"tfn_exemption_type\": {\n \"value\": \"\"\n },\n \"work_condition\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"address_line_1\": {\n \"value\": \"\"\n },\n \"address_line_2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postcode\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n }\n },\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"phone_numbers\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"employee_provided_at\": \"2023-02-01T12:00:00Z\",\n \"partner_provided_at\": \"2023-02-01T12:00:00Z\",\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"id\": {\n \"value\": \"\"\n },\n \"country_of_origin\": {\n \"value\": \"\"\n },\n \"employment_type\": {\n \"value\": \"\"\n },\n \"has_financial_supplement_debt\": {\n \"value\": \"\"\n },\n \"has_study_and_training_repayment\": {\n \"value\": \"\"\n },\n \"income_type\": {\n \"value\": \"\"\n },\n \"pay_basis\": {\n \"value\": \"\"\n },\n \"residency_type\": {\n \"value\": \"\"\n },\n \"senior_marital_status\": {\n \"value\": \"\"\n },\n \"tax_free_threshold_claimed\": {\n \"value\": \"\"\n },\n \"tax_scale_type\": {\n \"value\": \"\"\n },\n \"tfn\": {\n \"value\": \"\"\n },\n \"tfn_exemption_type\": {\n \"value\": \"\"\n },\n \"work_condition\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3a1c985-33c5-4623-b59a-546d485be826", "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "inserted_at" }, { "key": "sort_order", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b87e3fe-d5df-473e-b566-a66627c454af", "name": "Unprocessible entity", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "inserted_at" }, { "key": "sort_order", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f2613eed-b5c4-489a-ab47-71b6c146507d", "name": "employer", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "474243a7-a151-45ad-b70d-3472493a351f", "name": "Show all employers", "request": { "name": "Show all employers", "description": { "content": "Returns a list of all employers that you have access to in the system. The returned employers will be scoped to the product key made in the request.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "The page number for pagination, can not be a negative number or 0, Defaults to 1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "54760409-737d-4627-bace-00a954d656d5", "name": "Employer response", "originalRequest": { "url": { "path": [ "api", "v1", "employer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12763c3c-2667-4aab-aa62-bffb164ac4f8", "name": "Problem parsing the request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "employer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3546562-e79f-4e15-b2be-603d4f59c16d", "name": "Create a new employer", "request": { "name": "Create a new employer", "description": { "content": "Creates a new employer in the system. The create employer will belong to the product key used in the header when the request is made.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8d33434e-cb5d-4be0-95ef-7d491a92d55d", "name": "The created employer", "originalRequest": { "url": { "path": [ "api", "v1", "employer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7714b95f-090b-4d13-862a-e943fac5df35", "name": "List employees for an employer", "request": { "name": "List employees for an employer", "description": { "content": "List employees for an employer", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "The page number for pagination, can not be a negative number or 0, Defaults to 1" }, { "disabled": false, "key": "sort_by", "value": "", "description": "The field to sort by, must be one of `given_name`, `family_name`, or `inserted_at`. Defaults to `inserted_at`" }, { "disabled": false, "key": "sort_order", "value": "", "description": "The sort order (`asc` or `desc`). Defaults to `asc`" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3601150d-1569-4547-8044-2c2092e72d34", "name": "Employee list", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "inserted_at" }, { "key": "sort_order", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"data\": [\n {\n \"address\": null,\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"phone_numbers\": [\n {\n \"employee_provided_at\": null,\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"partner_provided_at\": null,\n \"phone_number\": \"+61443213999\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"verified_at\": \"2026-01-19T23:59:33Z\"\n }\n ],\n \"remote_id\": \"e7d8e7ba-062e-419e-95b6-b7c4ff3a052d\",\n \"super_fund_details\": {\n \"super_fund_memberships\": []\n },\n \"tax_detail\": null,\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n }\n ],\n \"version\": \"v1\"\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b713cbf5-53ca-4068-9c0e-98490b78f1f4", "name": "Not found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "inserted_at" }, { "key": "sort_order", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2491fd45-68ee-4108-9e50-64fb650177ce", "name": "Unprocessible entity", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "employees" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "sort_by", "value": "inserted_at" }, { "key": "sort_order", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "736ad418-f624-49b9-bba7-81c47ffa40d2", "name": "Delete an employer", "request": { "name": "Delete an employer", "description": {}, "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e2a93685-60c7-42a2-836f-435626b8a02f", "name": "An empty response indicating deletion", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b852c28-ba07-4d12-90c4-d172c952a11d", "name": "Employer with the supplied id could not be found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18ba0cc6-70e0-448a-bf01-de58b18c1f32", "name": "Get a single employer", "request": { "name": "Get a single employer", "description": {}, "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "500bf469-a1f2-472b-922a-56f1b0761fe4", "name": "Employer response", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b2837b5-86c8-4196-92c8-be5c84284d1f", "name": "Employer with the supplied id could not be found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c884f40-d6b9-40aa-a5e3-70647a8b6fae", "name": "Update an employer", "request": { "name": "Update an employer", "description": {}, "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "82d6c6c7-efbb-4087-b0d1-00780f5dbfd1", "name": "The updated employer", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf0f65fd-6494-4ef5-89e8-7cc60998c2e9", "name": "Employer with the supplied id could not be found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b6cd7cf-8bb4-4733-b59c-a459783a4481", "name": "Update an employer", "request": { "name": "Update an employer", "description": {}, "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f1303d96-3bce-4bf7-afe3-deb0fca4867e", "name": "The updated employer", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb05911-d056-4e18-af74-4fbf744da33a", "name": "Employer with the supplied id could not be found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"country\": \"\",\n \"name\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"address_line_1\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\",\n \"address_line_2\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\"\n },\n \"employer_default_super_fund_product\": {\n \"accepted_ato_standard_business_reporting_terms\": \"\",\n \"brand_id\": \"\",\n \"employer_number\": \"\"\n },\n \"remote_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b9cf6d93-48f4-4d48-91fd-595621c9a877", "name": "employer_embed_url", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2d54a457-e4de-4d3c-9713-21f5b9ea0a0a", "name": "Generate employer embed URL", "request": { "name": "Generate employer embed URL", "description": { "content": "Used to generate a URL which can be used with our JavaScript library to place an employer embed into the page", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer", ":employer_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "valid_until", "value": "", "description": "(Required) At this datetime the embed will expire and any attempt to load the embed using will fail. Embeds can be used after the expiry time, they just cannot be loaded. This should be a short expiry (around 1 hour)." }, { "disabled": false, "key": "app", "value": "", "description": "(Required) Determines which application is rendered inside the employer embed.\n\n### Supported values\n\n- `super_settings`\n Default super fund configuration **and** ATO configuration.\n\n- `super_details`\n Default super fund configuration only.\n\n- `templates`\n Onboarding templates configuration.\n\n- `mfa`\n SuperAPI-hosted multi-factor authentication setup.\n\n- `policy_management`\n Employer policy management configuration.\n\n- `ato_settings`\n ATO configuration only.\n\n### Notes\n\n- Please contact us for help on this setting.\n" }, { "disabled": false, "key": "session_id", "value": "", "description": "(Required) This should be set to a unique for the user that is interacting with the embed. Short term data, e.g. filter settings, are tracked using this value. The primary key of a user or key of a record representing the join between a user and a company is a good value to use here." }, { "disabled": false, "key": "target_origin", "value": "", "description": "If the embed is to be placed on a different domain from the standard product target origin, set this value to override it. Must be a fully qualified domain (e.g. https://example.com). The use of `localhost` is supported for development purposes. If not provided, the product's configured target_origin will be used." }, { "disabled": false, "key": "email", "value": "", "description": "Optional user details to create or update an employer user for this embed session. If provided, the user will be linked to the employer." }, { "disabled": false, "key": "first_name", "value": "", "description": "Optional user details to create or update an employer user for this embed session. If provided, the user will be linked to the employer." }, { "disabled": false, "key": "last_name", "value": "", "description": "Optional user details to create or update an employer user for this embed session. If provided, the user will be linked to the employer." }, { "disabled": false, "key": "phone_number", "value": "", "description": "Optional user details to create or update an employer user for this embed session. If provided, the user will be linked to the employer." }, { "disabled": false, "key": "role", "value": "user", "description": "Optional user details to create or update an employer user for this embed session. If provided, the user will be linked to the employer." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The employer id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ada107d5-18b1-4336-9c43-aad1d3c0da55", "name": "Employer embed URL", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2021-12-31T23:59:59Z" }, { "key": "app", "value": "super_settings" }, { "key": "session_id", "value": "session_123" }, { "key": "target_origin", "value": "https://example.com" }, { "key": "email", "value": "accountant@example.com" }, { "key": "first_name", "value": "Jane" }, { "key": "last_name", "value": "Smith" }, { "key": "phone_number", "value": "+61400000000" }, { "key": "role", "value": "user" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The employer id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"embed_url\": \"string\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85c17ab6-824a-4859-822b-88b9127c26a9", "name": "Employer with the supplied id could not be found", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2021-12-31T23:59:59Z" }, { "key": "app", "value": "super_settings" }, { "key": "session_id", "value": "session_123" }, { "key": "target_origin", "value": "https://example.com" }, { "key": "email", "value": "accountant@example.com" }, { "key": "first_name", "value": "Jane" }, { "key": "last_name", "value": "Smith" }, { "key": "phone_number", "value": "+61400000000" }, { "key": "role", "value": "user" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The employer id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7426d9b1-5168-4a76-9dbc-beb91d0de814", "name": "employer_templates", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e27561ed-229f-4ba3-8ad3-a9def25c1d8f", "name": "Show all employer templates", "request": { "name": "Show all employer templates", "description": { "content": "Returns a list of templates associated with the employer.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer", ":employer_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4aa5eb0c-e6df-4dd0-af87-6b42965a2182", "name": "Employer template response", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"description\": \"string\",\n \"id\": \"string\",\n \"inserted_at\": \"string\",\n \"name\": \"string\",\n \"updated_at\": \"string\"\n },\n {\n \"description\": \"string\",\n \"id\": \"string\",\n \"inserted_at\": \"string\",\n \"name\": \"string\",\n \"updated_at\": \"string\"\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c26d7b4b-2f59-4dda-b7f7-e8de101b6822", "name": "Get a single employer's template", "request": { "name": "Get a single employer's template", "description": { "content": "Returns a template.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "employer", ":employer_id", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding template" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c0c2dc31-c365-4033-9f24-e1f7820271af", "name": "Employer template response", "originalRequest": { "url": { "path": [ "api", "v1", "employer", ":employer_id", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employer_id", "description": "(Required) The primary key of the employer" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding template" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"description\": \"string\",\n \"id\": \"string\",\n \"inserted_at\": \"string\",\n \"name\": \"string\",\n \"updated_at\": \"string\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4369b2b3-f7ea-466f-bd18-d24225794853", "name": "mfa_embed_url", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "68a59821-63f1-4292-aa30-77cabe00f13d", "name": "Generate MFA embed URL", "request": { "name": "Generate MFA embed URL", "description": { "content": "Used to generate a URL which can be used with our JavaScript library to place an MFA verification embed into the page. If an employee has multiple phone numbers, they will be prompted to select which phone number to verify.\n\nMFA sessions are employee scoped and identified by the `session_id` parameter. Providing the same `session_id` will load the same session, allowing employees to continue with their verification attempts. If no existing session is found, a new session will be created and the status code will be `201 Created`.\n\nEmployees can verify their phone number up to a maximum number of attempts, defined by the `max_attempts` parameter. If the maximum number attempts is reached, the user will no longer be able to provide a verification code and `mfa_verification:complete` will be dispatched and `verified_at` will be `null`.\n\nThe target origin for this embed will use the same domain as the [product associated to the employer](/#tag/product/operation/SuperApiWeb.Api.V1.ProductController.index) unless the `target_origin` parameter is provided.\n\nTo determine whether or not an employee has verified their phone number, check the `verified_at` field on the employee using the [employee endpoint](#tag/employee/operation/SuperApiWeb.Api.V1.EmployeeController.show).\n\nVerification codes have a validity period of 5 minutes once the code has been sent. Once verified, a iframe post message `mfa_verification:complete` event.\n\n```json\n{\n \"verified_at\": \"2023-10-01T12:00:00Z\"\n}\n```\n\nYou can always use this embed to verify a phone number any amount of times. However, if an employee has initialized the verification process, they will always be prompted to complete it. If you require a new verification process, provide a different `session_id`.\n\n> Session IDs are persisted once the employee has started the verification process as employees may have multiple phone numbers. Once a phone number is selected, the session ID is tied to that instance and phone number.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "mfa-verification", "employee", ":employee_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "valid_until", "value": "", "description": "(Required) Dictates when the embed should no longer render past a a ISO-8601 UTC date time string" }, { "disabled": false, "key": "app", "value": "", "description": "(Required) The application context for the embed. Currently only `mfa` is supported." }, { "disabled": false, "key": "session_id", "value": "", "description": "(Required) A unique identifier for the session, used to track user interactions with the embed and load previous MFA sessions. This should align to a entry which represents an employee's MFA attempt." }, { "disabled": false, "key": "max_attempts", "value": "", "description": "(Required) The maximum number of attempts the employee has to verify their phone number. This is used to limit the number of verification attempts." }, { "disabled": false, "key": "target_origin", "value": "", "description": "If the MFA session is to be placed on a different domain from the standard product, set this value to override the target origin. Must be a fully qualified domain (e.g. https://example.com). The use of `localhost` is supported for development purposes." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The employee ID. Using a product API key that is not associated with the employee's employer will result in a 404 error." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c055360d-bbd3-4cc5-a599-40ee7d3cf1d4", "name": "An existing MFA session", "originalRequest": { "url": { "path": [ "api", "v1", "mfa-verification", "employee", ":employee_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2099-12-31T23:59:59Z" }, { "key": "app", "value": "mfa" }, { "key": "session_id", "value": "YOUR_INTERNAL_SESSION_ID" }, { "key": "max_attempts", "value": "3" }, { "key": "target_origin", "value": "https://example.com" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The employee ID. Using a product API key that is not associated with the employee's employer will result in a 404 error." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"embed_url\": \"https://api.superapi.com.au/embed/v1/mfa-verification/00000000-1111-2222-3333-444444444444/verify?&max_attempts=3&app=mfa&valid_until=2025-06-14T02%3A54%3A21.270302Z&signed=SIGNED_TOKEN\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc28e940-bce1-4613-9997-fe1822ae8da2", "name": "A new MFA session", "originalRequest": { "url": { "path": [ "api", "v1", "mfa-verification", "employee", ":employee_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2099-12-31T23:59:59Z" }, { "key": "app", "value": "mfa" }, { "key": "session_id", "value": "YOUR_INTERNAL_SESSION_ID" }, { "key": "max_attempts", "value": "3" }, { "key": "target_origin", "value": "https://example.com" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The employee ID. Using a product API key that is not associated with the employee's employer will result in a 404 error." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"embed_url\": \"https://api.superapi.com.au/embed/v1/mfa-verification/00000000-1111-2222-3333-444444444444/verify?&max_attempts=3&app=mfa&valid_until=2025-06-14T02%3A54%3A21.270302Z&signed=SIGNED_TOKEN\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24b36fa1-1f9f-4f7c-ad98-424a406b1373", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "mfa-verification", "employee", ":employee_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2099-12-31T23:59:59Z" }, { "key": "app", "value": "mfa" }, { "key": "session_id", "value": "YOUR_INTERNAL_SESSION_ID" }, { "key": "max_attempts", "value": "3" }, { "key": "target_origin", "value": "https://example.com" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The employee ID. Using a product API key that is not associated with the employee's employer will result in a 404 error." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99337ce3-cb20-43ce-8b64-4cb0c88b7590", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "api", "v1", "mfa-verification", "employee", ":employee_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2099-12-31T23:59:59Z" }, { "key": "app", "value": "mfa" }, { "key": "session_id", "value": "YOUR_INTERNAL_SESSION_ID" }, { "key": "max_attempts", "value": "3" }, { "key": "target_origin", "value": "https://example.com" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "employee_id", "description": "(Required) The employee ID. Using a product API key that is not associated with the employee's employer will result in a 404 error." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "578f3a28-12ca-4e53-9e9f-dbc207f3f19d", "name": "onboarding_session", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0fc05deb-a077-4eb3-924f-c4188be47e48", "name": "Show all onboarding sessions", "request": { "name": "Show all onboarding sessions", "description": {}, "url": { "path": [ "api", "v1", "onboarding-session" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "The page number for pagination, can not be a negative number or 0, Defaults to 1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "99d3b4c3-b1d5-4e1d-97f4-ea4ac94bdfbd", "name": "Onboarding session list response", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"1234567890\",\n \"branch\": {\n \"address\": \"Miller & Mount Sts\",\n \"branch\": \"MLC Building Society (DES)\",\n \"bsb\": \"021111\",\n \"mnemonic\": \"NAB\",\n \"postcode\": \"2060\",\n \"state\": \"nsw\",\n \"suburb\": \"North Sydney\"\n },\n \"name\": \"John Doe 0\",\n \"rank\": 0,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 100\n }\n }\n ],\n \"outcome\": \"complete\"\n },\n \"data_delivery_state\": \"collect_super_details\",\n \"document_uploads\": null,\n \"email\": \"openspec+arpa@example.com\",\n \"email_validated\": true,\n \"employee\": {\n \"address\": null,\n \"employer\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"phone_numbers\": [\n {\n \"employee_provided_at\": null,\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"partner_provided_at\": null,\n \"phone_number\": \"+61443213211\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"verified_at\": \"2026-01-19T23:59:33Z\"\n }\n ],\n \"remote_id\": \"a0281b8f-bc9b-4b10-a5f7-530f1b16cd23\",\n \"super_fund_details\": {\n \"super_fund_memberships\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": null,\n \"work_condition\": null\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"confidence_score\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"address_line_3\": null,\n \"address_line_4\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"super_details\": {\n \"smsf\": null,\n \"super_funds\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": \"pending\",\n \"work_condition\": null\n }\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"email\": \"test@example.com\",\n \"locality\": \"West Footscray\",\n \"name\": \"Test Example\",\n \"phone_number\": \"+61412345678\",\n \"postcode\": \"3056\",\n \"relationship\": \"Friend\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"2000-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"gender_other\": null,\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\",\n \"title_other\": null\n },\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"2026-02-18T23:59:34Z\",\n \"fair_work_statements\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\",\n \"fixed_term_contract\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000//s3/path/to/openspec-form-document-response.pdf?response-content-disposition=attachment%3B%20filename%3DOpenspec%20Form%20Document%20%28Signed%29.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=b28a1cb1eb1a5530bed365584ccd105e3f63e764580c8c7f364809dd6b3061c5\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Form Document\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ],\n \"outcome\": \"complete\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"last_activity_at\": null,\n \"onboarding_session_super_selection\": {\n \"outcome\": \"incomplete\",\n \"progress_state\": \"select_member_details\",\n \"select_super_fund_product\": {\n \"is_default_selection\": false,\n \"member_number\": null,\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n }\n },\n \"self_managed_super_fund\": null,\n \"super_fund_member_detail\": null\n },\n \"phone_number\": \"+61443213211\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"outcome\": \"incomplete\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/policies-c62f31bb-4d41-44c7-821f-9ff23dd198fd.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d33839fc9a0a2be6788010a1ac33e179d055aab9e39bb2313ffb45e5f27e964c\",\n \"policy_acknowledgement_id\": \"8420a9e4-95e8-4938-b0bb-ef5644590ffe\"\n }\n ],\n \"outcome\": \"complete\",\n \"policy_acknowledgements\": [\n {\n \"acknowledged_at\": \"2026-01-31T12:00:00\",\n \"description\": \"This is a demo employer policy for Openspec.\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Employer Policy\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 1,\n \"is_abandoned\": false\n },\n \"remote_id\": \"37dd63d3-0460-44e4-9db8-a867fec380cc\",\n \"super_disclaimer\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\"\n },\n \"target_origin\": null,\n \"template_id\": \"f13afd01-245d-40b4-9144-8326c861d689\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"outcome\": \"complete\",\n \"tfn_declaration\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"country_of_origin\": null,\n \"country_of_origin_alpha_2\": null,\n \"country_of_origin_name\": null,\n \"date_of_birth\": \"1980-04-11\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": true,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"Richardson\",\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"given_name\": \"Sam\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"locality\": \"West Footscray\",\n \"middle_name\": null,\n \"pay_basis\": \"full_time\",\n \"postcode\": \"3056\",\n \"previous_family_name\": \"Cuming\",\n \"previous_given_name\": \"Samuel\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"state\": \"vic\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"049333118\",\n \"tfn_exemption_type\": null,\n \"title\": \"mr\"\n }\n }\n },\n {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"1234567890\",\n \"branch\": {\n \"address\": \"Miller & Mount Sts\",\n \"branch\": \"MLC Building Society (DES)\",\n \"bsb\": \"021111\",\n \"mnemonic\": \"NAB\",\n \"postcode\": \"2060\",\n \"state\": \"nsw\",\n \"suburb\": \"North Sydney\"\n },\n \"name\": \"John Doe 0\",\n \"rank\": 0,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 100\n }\n }\n ],\n \"outcome\": \"complete\"\n },\n \"data_delivery_state\": \"collect_super_details\",\n \"document_uploads\": null,\n \"email\": \"openspec+arpa@example.com\",\n \"email_validated\": true,\n \"employee\": {\n \"address\": null,\n \"employer\": {\n \"abn\": \"67674661244\",\n \"abn_branch_number\": null,\n \"address\": {\n \"address_line_1\": \"1 Missing Member No Way\",\n \"address_line_2\": null,\n \"locality\": \"Gisborne\",\n \"postcode\": \"3437\",\n \"state\": \"vic\"\n },\n \"contact\": {\n \"email\": \"payroll@superchoiceform.com.au\",\n \"name\": \"School Driver\",\n \"phone_number\": \"0480586728\"\n },\n \"country\": \"aus\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"123456789\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"last_activity_at\": null,\n \"name\": \"Openspec Demo Employer\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": true,\n \"stapling_enabled\": true,\n \"tfnd_enabled\": true\n },\n \"onboarding_status\": \"complete\",\n \"remote_id\": \"b2238339-1405-4b43-91a6-f01d007996dd\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"phone_numbers\": [\n {\n \"employee_provided_at\": null,\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"partner_provided_at\": null,\n \"phone_number\": \"+61443213211\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"verified_at\": \"2026-01-19T23:59:33Z\"\n }\n ],\n \"remote_id\": \"a0281b8f-bc9b-4b10-a5f7-530f1b16cd23\",\n \"super_fund_details\": {\n \"super_fund_memberships\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": null,\n \"work_condition\": null\n },\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"confidence_score\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"address_line_3\": null,\n \"address_line_4\": null,\n \"locality\": \"West Footscray\",\n \"postcode\": \"3056\",\n \"state\": \"vic\"\n },\n \"identity\": {\n \"date_of_birth\": \"1995-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\"\n },\n \"super_details\": {\n \"smsf\": null,\n \"super_funds\": []\n },\n \"tax_detail\": {\n \"country_of_origin\": null,\n \"employment_type\": \"employee\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"income_type\": \"salary_and_wages\",\n \"pay_basis\": \"casual\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"senior_marital_status\": null,\n \"tax_free_threshold_claimed\": true,\n \"tax_scale_type\": \"regular\",\n \"tfn\": \"123123213\",\n \"tfn_exemption_type\": \"pending\",\n \"work_condition\": null\n }\n },\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"updated_at\": \"2026-01-19T23:59:33Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"email\": \"test@example.com\",\n \"locality\": \"West Footscray\",\n \"name\": \"Test Example\",\n \"phone_number\": \"+61412345678\",\n \"postcode\": \"3056\",\n \"relationship\": \"Friend\",\n \"state\": \"vic\"\n },\n \"outcome\": \"complete\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"2000-01-01\",\n \"family_name\": \"Richardson\",\n \"gender\": \"male\",\n \"gender_other\": null,\n \"given_name\": \"Sam\",\n \"middle_name\": null,\n \"title\": \"mr\",\n \"title_other\": null\n },\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"2026-02-18T23:59:34Z\",\n \"fair_work_statements\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\",\n \"fixed_term_contract\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000//s3/path/to/openspec-form-document-response.pdf?response-content-disposition=attachment%3B%20filename%3DOpenspec%20Form%20Document%20%28Signed%29.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=b28a1cb1eb1a5530bed365584ccd105e3f63e764580c8c7f364809dd6b3061c5\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Form Document\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ],\n \"outcome\": \"complete\"\n },\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"last_activity_at\": null,\n \"onboarding_session_super_selection\": {\n \"outcome\": \"incomplete\",\n \"progress_state\": \"select_member_details\",\n \"select_super_fund_product\": {\n \"is_default_selection\": false,\n \"member_number\": null,\n \"super_fund_product\": {\n \"abn\": \"12345678901\",\n \"inserted_at\": \"2026-01-19T23:59:33Z\",\n \"name\": \"Openspec Super\",\n \"updated_at\": \"2026-01-19T23:59:33Z\",\n \"usi_number\": \"OPENSPEC001\"\n }\n },\n \"self_managed_super_fund\": null,\n \"super_fund_member_detail\": null\n },\n \"phone_number\": \"+61443213211\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"outcome\": \"incomplete\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/policies-c62f31bb-4d41-44c7-821f-9ff23dd198fd.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d33839fc9a0a2be6788010a1ac33e179d055aab9e39bb2313ffb45e5f27e964c\",\n \"policy_acknowledgement_id\": \"8420a9e4-95e8-4938-b0bb-ef5644590ffe\"\n }\n ],\n \"outcome\": \"complete\",\n \"policy_acknowledgements\": [\n {\n \"acknowledged_at\": \"2026-01-31T12:00:00\",\n \"description\": \"This is a demo employer policy for Openspec.\",\n \"inserted_at\": \"2026-01-19T23:59:33\",\n \"name\": \"Openspec Employer Policy\",\n \"updated_at\": \"2026-01-19T23:59:33\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 1,\n \"is_abandoned\": false\n },\n \"remote_id\": \"37dd63d3-0460-44e4-9db8-a867fec380cc\",\n \"super_disclaimer\": {\n \"accepted_at\": \"2026-01-19T23:59:33Z\",\n \"outcome\": \"complete\"\n },\n \"target_origin\": null,\n \"template_id\": \"f13afd01-245d-40b4-9144-8326c861d689\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"outcome\": \"complete\",\n \"tfn_declaration\": {\n \"address_line_1\": \"Apartment 3\",\n \"address_line_2\": \"108 Union Street\",\n \"country_of_origin\": null,\n \"country_of_origin_alpha_2\": null,\n \"country_of_origin_name\": null,\n \"date_of_birth\": \"1980-04-11\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": true,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"Richardson\",\n \"generated\": {\n \"nat_3092_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form-nat-3092.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=b36572136473957d8f0ed8534192649871778437e36c4e21cac3703c8d355f35\",\n \"nat_74911_pdf\": null,\n \"tfn_declaration_form_pdf\": \"http://minio:9000/generated-assets/840932b9-10b0-4b61-9f37-3efa4f7d6c23/tfn-declaration-form.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=admin%2F20260119%2Flocal%2Fs3%2Faws4_request&X-Amz-Date=20260119T235933Z&X-Amz-Expires=561600&X-Amz-SignedHeaders=host&X-Amz-Signature=d89851dbacf4abc3638530a80d4d3777239ad8be05f6db1be8302ab191d32e68\"\n },\n \"given_name\": \"Sam\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": false,\n \"locality\": \"West Footscray\",\n \"middle_name\": null,\n \"pay_basis\": \"full_time\",\n \"postcode\": \"3056\",\n \"previous_family_name\": \"Cuming\",\n \"previous_given_name\": \"Samuel\",\n \"residency_type\": \"australian_resident_for_tax_purposes\",\n \"state\": \"vic\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"049333118\",\n \"tfn_exemption_type\": null,\n \"title\": \"mr\"\n }\n }\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dce798aa-29f1-4e91-83cf-f69ba2e323d2", "name": "Problem parsing the request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c9fd1f9-eb92-470c-afda-dc943eedd6af", "name": "Create a new onboarding session", "request": { "name": "Create a new onboarding session", "description": { "content": "Creates a new onboarding session. For more details on the onboarding session flow, please view [working with onboarding sessions](https://docs.superapi.com.au/software_partners/how_to_guides/work_with_onboarding_sessions/). The following conditions must be met for onboarding sessions to be created:\n\n- The employee's employer **MUST** have a default superannuation fund set up. This should be done via the employer embed, or via the employer API.\n- When an onboarding session template is provided, it must already exist.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "onboarding-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"remote_id\": \"\",\n \"workflow_slug\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": \"\",\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"\",\n \"homepage_url\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"usi_number\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"\"\n },\n \"email_validated\": \"\",\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": \"\",\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\"\n },\n \"fair_work_statements\": [\n \"\",\n \"\"\n ],\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"target_origin\": \"\",\n \"template_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81367f4d-afe4-4be7-bfe6-39d825425b74", "name": "The created onboarding session", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"remote_id\": \"\",\n \"workflow_slug\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"email_validated\": \"\",\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"fair_work_statements\": [\n \"\",\n \"\"\n ],\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"target_origin\": \"\",\n \"template_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 6897,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 451.67862916074444\n }\n },\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 7493,\n \"split\": {\n \"kind\": \"fixed_amount\",\n \"value\": 6416.742849778847\n }\n }\n ],\n \"id\": \"bedf4630-77d7-97c6-ef3b-a4868c3b0667\",\n \"outcome\": \"complete\"\n },\n \"data_delivery_state\": \"acknowledge_employer_policies\",\n \"document_uploads\": {\n \"generated\": {\n \"archive_url\": \"string\"\n },\n \"id\": \"48c6844b-9218-5bc4-971f-368dfc676b37\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"email\": \"string\",\n \"email_validated\": true,\n \"employee\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {},\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"identity\": {},\n \"phone_numbers\": [\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n },\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"tax_detail\": {}\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"confidence_score\": 1225.2936776780987,\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"553ee271-4453-66e8-b687-8318809e6be9\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {},\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"email\": \"string\",\n \"locality\": \"string\",\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"postcode\": \"string\",\n \"relationship\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"0ead0c6a-bf23-383a-b205-dcbdc753cffc\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"1982-07-11\",\n \"family_name\": \"string\",\n \"gender\": \"male\",\n \"gender_other\": \"string\",\n \"given_name\": \"string\",\n \"middle_name\": \"string\",\n \"title\": \"ms\",\n \"title_other\": \"string\"\n },\n \"id\": \"321b461b-458e-0c15-b9d9-e07eb4234be8\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"expires_at\": \"string\",\n \"fair_work_statements\": {\n \"accepted_at\": \"string\",\n \"id\": \"571089f4-633c-6229-8f15-89f358cf261a\",\n \"outcome\": \"incomplete\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"outcome\": \"complete_unsuccessful\"\n },\n \"id\": \"f66288bc-510d-0806-0a25-9d84d808244d\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"string\",\n \"onboarding_session_super_selection\": {\n \"generated\": {\n \"compliance_letter_url\": \"string\",\n \"super_choice_form_pdf_merged_url\": \"string\",\n \"super_choice_form_pdf_url\": \"string\"\n },\n \"id\": \"72c41c78-da0d-4868-e12c-aaa04a12d546\",\n \"outcome\": \"complete_without_member_number\",\n \"progress_state\": \"string\",\n \"select_super_fund_product\": {\n \"id\": \"08356b0e-526f-4dae-459c-7e77a6d52b04\",\n \"is_default_selection\": false,\n \"member_number\": \"string\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"self_managed_super_fund\": {\n \"bank_account_bsb\": \"string\",\n \"bank_account_name\": \"string\",\n \"bank_account_number\": \"string\",\n \"fund_abn\": \"string\",\n \"fund_electronic_service_address\": \"netwealthsmsf\",\n \"fund_name\": \"string\",\n \"id\": \"db5eb10d-c1f1-eaae-8e3e-6992e2af2b7a\",\n \"member_name\": \"string\",\n \"member_number\": \"string\"\n },\n \"super_fund_member_detail\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"address_line_3\": \"string\",\n \"address_line_4\": \"string\",\n \"date_of_birth\": \"1994-07-10\",\n \"family_name\": \"string\",\n \"gender\": \"other\",\n \"given_name\": \"string\",\n \"id\": \"0c1369b0-68a4-aeee-8892-9db11f0d7f02\",\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"state\": \"\",\n \"tfn\": \"string\",\n \"title\": \"ms\"\n }\n },\n \"phone_number\": \"string\",\n \"phone_number_validated\": false,\n \"phone_verification\": {\n \"id\": \"58253828-60cb-9b3d-1ff2-5c44e2f15f08\",\n \"outcome\": \"complete\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"http://vprQjMnFpTgxXwm.gfWjcWZ99KMoMzxqowUb1gELo9WfQiYuuzHRjja+DlpF,NZs8m1\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n {\n \"download_url\": \"https://WpQQVxDLLYzAuOzGyafDCjKeJQffsuPT.vnmwNKV7sk6Az0\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"id\": \"5f423a46-5627-86f8-301f-37f404a9c9f5\",\n \"outcome\": \"incomplete\",\n \"policy_acknowledgements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 0.75,\n \"is_abandoned\": false\n },\n \"remote_id\": \"string\",\n \"super_disclaimer\": {\n \"accepted_at\": \"string\",\n \"id\": \"b852c9fd-b843-d9a7-e438-e973a70dbbfa\",\n \"outcome\": \"complete\"\n },\n \"target_origin\": \"string\",\n \"template_id\": \"string\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"id\": \"84724e23-e9c3-4318-554c-4a869fc26f1f\",\n \"outcome\": \"complete\",\n \"tfn_declaration\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"country_of_origin\": \"tto\",\n \"country_of_origin_alpha_2\": \"string\",\n \"country_of_origin_name\": \"string\",\n \"date_of_birth\": \"2010-02-25\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": false,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"string\",\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"given_name\": \"string\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": true,\n \"id\": \"752da1f2-a8a0-ef03-ca1b-89711a7a86ce\",\n \"locality\": \"string\",\n \"middle_name\": \"string\",\n \"pay_basis\": \"\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"residency_type\": \"\",\n \"state\": \"\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"string\",\n \"tfn_exemption_type\": \"under_eighteen\",\n \"title\": \"miss\"\n }\n }\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26dcc632-e46b-4dd6-ab42-9916ab63d031", "name": "Cancels an onboarding session", "request": { "name": "Cancels an onboarding session", "description": { "content": "An onboarding session can only be cancelled in certain states. If the onboarding session is in a state where there are pending responses from a super fund, it will not be possible to cancel the onboarding session.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6c9e62af-7d5c-4e30-9c2c-093a3ed41649", "name": "An empty response indicating cancellation", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a468f7f-e181-4b8e-8ce2-5ebff8391261", "name": "Onboarding session not found", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d11be1d-025a-4f47-8c7f-e68f9d35bfe5", "name": "Onboarding session cannot be cancelled", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4dbba16f-0da0-4a01-a304-a9e05ea64103", "name": "Get a single onboarding session", "request": { "name": "Get a single onboarding session", "description": {}, "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "201db87b-64e1-46b8-8f7b-ea464aed785a", "name": "Onboarding session response", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 908,\n \"split\": {\n \"kind\": \"fixed_amount\",\n \"value\": 2655.5075193596745\n }\n },\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 476,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 9286.73487226536\n }\n }\n ],\n \"id\": \"71a326aa-cac0-9966-8a4f-19cd6d0b5a2e\",\n \"outcome\": \"incomplete\"\n },\n \"data_delivery_state\": \"completed\",\n \"document_uploads\": {\n \"generated\": {\n \"archive_url\": \"string\"\n },\n \"id\": \"55603a73-2855-53b6-e720-4aff3537dceb\",\n \"outcome\": \"complete\"\n },\n \"email\": \"string\",\n \"email_validated\": true,\n \"employee\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {},\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"identity\": {},\n \"phone_numbers\": [\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n },\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"tax_detail\": {}\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"confidence_score\": 9087.839221917468,\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"dcf80f04-ef4e-825d-7997-8e9b9d5ccda2\",\n \"outcome\": \"incomplete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {},\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"email\": \"string\",\n \"locality\": \"string\",\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"postcode\": \"string\",\n \"relationship\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"2ceab1b5-3d7e-0ae0-7afc-d03d0600b4d5\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"1994-03-30\",\n \"family_name\": \"string\",\n \"gender\": \"other\",\n \"gender_other\": \"string\",\n \"given_name\": \"string\",\n \"middle_name\": \"string\",\n \"title\": \"dr\",\n \"title_other\": \"string\"\n },\n \"id\": \"cabe922a-52e9-468a-7fa8-3de3fde0100a\",\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"string\",\n \"fair_work_statements\": {\n \"accepted_at\": \"string\",\n \"id\": \"7349aeae-5d31-47aa-e0f8-bc3642964de2\",\n \"outcome\": \"complete_unsuccessful\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"outcome\": \"incomplete\"\n },\n \"id\": \"4f7fd681-f75a-d1b8-fab2-dd4a44c8b6ca\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"string\",\n \"onboarding_session_super_selection\": {\n \"generated\": {\n \"compliance_letter_url\": \"string\",\n \"super_choice_form_pdf_merged_url\": \"string\",\n \"super_choice_form_pdf_url\": \"string\"\n },\n \"id\": \"f0b22401-351d-5057-2e5e-65190ab0971d\",\n \"outcome\": \"incomplete\",\n \"progress_state\": \"string\",\n \"select_super_fund_product\": {\n \"id\": \"b995393c-33f5-e28f-866a-d861186b16f0\",\n \"is_default_selection\": true,\n \"member_number\": \"string\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"self_managed_super_fund\": {\n \"bank_account_bsb\": \"string\",\n \"bank_account_name\": \"string\",\n \"bank_account_number\": \"string\",\n \"fund_abn\": \"string\",\n \"fund_electronic_service_address\": \"ESUPERFUND\",\n \"fund_name\": \"string\",\n \"id\": \"2ec913dd-bfb5-999f-6637-e991a04155c1\",\n \"member_name\": \"string\",\n \"member_number\": \"string\"\n },\n \"super_fund_member_detail\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"address_line_3\": \"string\",\n \"address_line_4\": \"string\",\n \"date_of_birth\": \"2001-11-22\",\n \"family_name\": \"string\",\n \"gender\": \"male\",\n \"given_name\": \"string\",\n \"id\": \"3bf30ffe-9ff2-5258-9112-41361c119b27\",\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"state\": \"\",\n \"tfn\": \"string\",\n \"title\": \"mrs\"\n }\n },\n \"phone_number\": \"string\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"id\": \"08b3e3d2-3280-7d00-f53f-169e343c200a\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"https://FLQGNWihVipHZX.czxRatBGMgrBhf6LMWf7CafcjWz,mO9+hIV71GzjnNqIFcSAbKf8\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n {\n \"download_url\": \"https://EuHnDfyjvjSLQcWgtYDFhkxoLHJPmjDC.lmkpOQ71PlBn-RhP\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"id\": \"24448f2f-e74b-75a3-96d9-b2e9351e4bc1\",\n \"outcome\": \"complete_unsuccessful\",\n \"policy_acknowledgements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 0.75,\n \"is_abandoned\": false\n },\n \"remote_id\": \"string\",\n \"super_disclaimer\": {\n \"accepted_at\": \"string\",\n \"id\": \"4a17d1f6-3f65-0422-0c63-5566fbfe9cf1\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"target_origin\": \"string\",\n \"template_id\": \"string\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"id\": \"f091c4fd-aa88-2c2b-0b8d-4af08ada9752\",\n \"outcome\": \"complete_unsuccessful\",\n \"tfn_declaration\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"country_of_origin\": \"twn\",\n \"country_of_origin_alpha_2\": \"string\",\n \"country_of_origin_name\": \"string\",\n \"date_of_birth\": \"1984-09-30\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": false,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"string\",\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"given_name\": \"string\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": true,\n \"id\": \"e574ab84-11c6-3d88-96c9-db8294f3fa5c\",\n \"locality\": \"string\",\n \"middle_name\": \"string\",\n \"pay_basis\": \"\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"residency_type\": \"\",\n \"state\": \"\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"string\",\n \"tfn_exemption_type\": \"pensioner\",\n \"title\": \"ms\"\n }\n }\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56de265e-9182-44a5-ba1e-ecd6d43c83a0", "name": "Update an onboarding session", "request": { "name": "Update an onboarding session", "description": { "content": "Updates an existing onboarding session. Changes to the following fields will **not** be applied when the following conditions are true:\n\n- Phone number changes will not be applied when the employee has already verified their phone number.\n- Email changes will not be applied when the employee has already verified their email address.\n- Changes to the employee's `remote_id` will not be applied once it has been set.\n- Changes to the employer's `remote_id` will not be applied once it has been set.\n\n> Changes to the employer record should be made via [this endpoint](#tag/employer/operation/SuperApiWeb.Api.V1.EmployerController.update (2))\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"email_validated\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": \"\",\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": \"\",\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"\",\n \"homepage_url\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"usi_number\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"\"\n },\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"remote_id\": \"\",\n \"target_origin\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7b9ce5fc-b2fb-4f7f-b1c4-4d4aa7cfac45", "name": "Onboarding session response", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"email_validated\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"remote_id\": \"\",\n \"target_origin\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 908,\n \"split\": {\n \"kind\": \"fixed_amount\",\n \"value\": 2655.5075193596745\n }\n },\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 476,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 9286.73487226536\n }\n }\n ],\n \"id\": \"71a326aa-cac0-9966-8a4f-19cd6d0b5a2e\",\n \"outcome\": \"incomplete\"\n },\n \"data_delivery_state\": \"completed\",\n \"document_uploads\": {\n \"generated\": {\n \"archive_url\": \"string\"\n },\n \"id\": \"55603a73-2855-53b6-e720-4aff3537dceb\",\n \"outcome\": \"complete\"\n },\n \"email\": \"string\",\n \"email_validated\": true,\n \"employee\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {},\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"identity\": {},\n \"phone_numbers\": [\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n },\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"tax_detail\": {}\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"confidence_score\": 9087.839221917468,\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"dcf80f04-ef4e-825d-7997-8e9b9d5ccda2\",\n \"outcome\": \"incomplete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {},\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"email\": \"string\",\n \"locality\": \"string\",\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"postcode\": \"string\",\n \"relationship\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"2ceab1b5-3d7e-0ae0-7afc-d03d0600b4d5\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"1994-03-30\",\n \"family_name\": \"string\",\n \"gender\": \"other\",\n \"gender_other\": \"string\",\n \"given_name\": \"string\",\n \"middle_name\": \"string\",\n \"title\": \"dr\",\n \"title_other\": \"string\"\n },\n \"id\": \"cabe922a-52e9-468a-7fa8-3de3fde0100a\",\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"string\",\n \"fair_work_statements\": {\n \"accepted_at\": \"string\",\n \"id\": \"7349aeae-5d31-47aa-e0f8-bc3642964de2\",\n \"outcome\": \"complete_unsuccessful\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"outcome\": \"incomplete\"\n },\n \"id\": \"4f7fd681-f75a-d1b8-fab2-dd4a44c8b6ca\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"string\",\n \"onboarding_session_super_selection\": {\n \"generated\": {\n \"compliance_letter_url\": \"string\",\n \"super_choice_form_pdf_merged_url\": \"string\",\n \"super_choice_form_pdf_url\": \"string\"\n },\n \"id\": \"f0b22401-351d-5057-2e5e-65190ab0971d\",\n \"outcome\": \"incomplete\",\n \"progress_state\": \"string\",\n \"select_super_fund_product\": {\n \"id\": \"b995393c-33f5-e28f-866a-d861186b16f0\",\n \"is_default_selection\": true,\n \"member_number\": \"string\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"self_managed_super_fund\": {\n \"bank_account_bsb\": \"string\",\n \"bank_account_name\": \"string\",\n \"bank_account_number\": \"string\",\n \"fund_abn\": \"string\",\n \"fund_electronic_service_address\": \"ESUPERFUND\",\n \"fund_name\": \"string\",\n \"id\": \"2ec913dd-bfb5-999f-6637-e991a04155c1\",\n \"member_name\": \"string\",\n \"member_number\": \"string\"\n },\n \"super_fund_member_detail\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"address_line_3\": \"string\",\n \"address_line_4\": \"string\",\n \"date_of_birth\": \"2001-11-22\",\n \"family_name\": \"string\",\n \"gender\": \"male\",\n \"given_name\": \"string\",\n \"id\": \"3bf30ffe-9ff2-5258-9112-41361c119b27\",\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"state\": \"\",\n \"tfn\": \"string\",\n \"title\": \"mrs\"\n }\n },\n \"phone_number\": \"string\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"id\": \"08b3e3d2-3280-7d00-f53f-169e343c200a\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"https://FLQGNWihVipHZX.czxRatBGMgrBhf6LMWf7CafcjWz,mO9+hIV71GzjnNqIFcSAbKf8\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n {\n \"download_url\": \"https://EuHnDfyjvjSLQcWgtYDFhkxoLHJPmjDC.lmkpOQ71PlBn-RhP\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"id\": \"24448f2f-e74b-75a3-96d9-b2e9351e4bc1\",\n \"outcome\": \"complete_unsuccessful\",\n \"policy_acknowledgements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 0.75,\n \"is_abandoned\": false\n },\n \"remote_id\": \"string\",\n \"super_disclaimer\": {\n \"accepted_at\": \"string\",\n \"id\": \"4a17d1f6-3f65-0422-0c63-5566fbfe9cf1\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"target_origin\": \"string\",\n \"template_id\": \"string\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"id\": \"f091c4fd-aa88-2c2b-0b8d-4af08ada9752\",\n \"outcome\": \"complete_unsuccessful\",\n \"tfn_declaration\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"country_of_origin\": \"twn\",\n \"country_of_origin_alpha_2\": \"string\",\n \"country_of_origin_name\": \"string\",\n \"date_of_birth\": \"1984-09-30\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": false,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"string\",\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"given_name\": \"string\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": true,\n \"id\": \"e574ab84-11c6-3d88-96c9-db8294f3fa5c\",\n \"locality\": \"string\",\n \"middle_name\": \"string\",\n \"pay_basis\": \"\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"residency_type\": \"\",\n \"state\": \"\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"string\",\n \"tfn_exemption_type\": \"pensioner\",\n \"title\": \"ms\"\n }\n }\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4d9e85-39d5-4674-b4b9-9dce391c2b88", "name": "Error response", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"email_validated\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"remote_id\": \"\",\n \"target_origin\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"detail\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eefb78e5-db58-42b9-8810-72345afdb82d", "name": "Update an onboarding session", "request": { "name": "Update an onboarding session", "description": { "content": "Updates an existing onboarding session. Changes to the following fields will **not** be applied when the following conditions are true:\n\n- Phone number changes will not be applied when the employee has already verified their phone number.\n- Email changes will not be applied when the employee has already verified their email address.\n- Changes to the employee's `remote_id` will not be applied once it has been set.\n- Changes to the employer's `remote_id` will not be applied once it has been set.\n\n> Changes to the employer record should be made via [this endpoint](#tag/employer/operation/SuperApiWeb.Api.V1.EmployerController.update (2))\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"email_validated\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": \"\",\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": \"\",\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"\",\n \"homepage_url\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"usi_number\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"\"\n },\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"remote_id\": \"\",\n \"target_origin\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f1da00d8-e184-4406-88a0-4e6367250fcb", "name": "Onboarding session response", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"email_validated\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"remote_id\": \"\",\n \"target_origin\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"bank_account_collection\": {\n \"bank_accounts\": [\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 908,\n \"split\": {\n \"kind\": \"fixed_amount\",\n \"value\": 2655.5075193596745\n }\n },\n {\n \"account_number\": \"string\",\n \"branch\": {\n \"address\": \"string\",\n \"branch\": \"string\",\n \"bsb\": \"string\",\n \"mnemonic\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\",\n \"suburb\": \"string\"\n },\n \"name\": \"string\",\n \"rank\": 476,\n \"split\": {\n \"kind\": \"percentage\",\n \"value\": 9286.73487226536\n }\n }\n ],\n \"id\": \"71a326aa-cac0-9966-8a4f-19cd6d0b5a2e\",\n \"outcome\": \"incomplete\"\n },\n \"data_delivery_state\": \"completed\",\n \"document_uploads\": {\n \"generated\": {\n \"archive_url\": \"string\"\n },\n \"id\": \"55603a73-2855-53b6-e720-4aff3537dceb\",\n \"outcome\": \"complete\"\n },\n \"email\": \"string\",\n \"email_validated\": true,\n \"employee\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address\": {},\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"value\": \"\"\n },\n \"contact\": {\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"identity\": {},\n \"phone_numbers\": [\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n },\n {\n \"employee_provided_at\": {\n \"value\": \"\"\n },\n \"partner_provided_at\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"verified_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"remote_id\": \"YOUR_INTERNAL_EMPLOYEE_ID\",\n \"super_details\": {\n \"super_fund_memberships\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"tax_detail\": {}\n },\n \"employee_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"confidence_score\": 9087.839221917468,\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"dcf80f04-ef4e-825d-7997-8e9b9d5ccda2\",\n \"outcome\": \"incomplete\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {},\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employee_emergency_contact\": {\n \"data\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"email\": \"string\",\n \"locality\": \"string\",\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"postcode\": \"string\",\n \"relationship\": \"string\",\n \"state\": \"\"\n },\n \"id\": \"2ceab1b5-3d7e-0ae0-7afc-d03d0600b4d5\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"employee_identity\": {\n \"data\": {\n \"date_of_birth\": \"1994-03-30\",\n \"family_name\": \"string\",\n \"gender\": \"other\",\n \"gender_other\": \"string\",\n \"given_name\": \"string\",\n \"middle_name\": \"string\",\n \"title\": \"dr\",\n \"title_other\": \"string\"\n },\n \"id\": \"cabe922a-52e9-468a-7fa8-3de3fde0100a\",\n \"outcome\": \"complete\"\n },\n \"expires_at\": \"string\",\n \"fair_work_statements\": {\n \"accepted_at\": \"string\",\n \"id\": \"7349aeae-5d31-47aa-e0f8-bc3642964de2\",\n \"outcome\": \"complete_unsuccessful\",\n \"statements\": [\n \"fair_work_information\",\n \"casual_employment\"\n ]\n },\n \"form_documents\": {\n \"generated\": [\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"download_url\": \"https://api.superapi.com.au/downloads/123e4567-e89b-12d3-a456-426614174000\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Employee contract\",\n \"type\": \"application/pdf\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"outcome\": \"incomplete\"\n },\n \"id\": \"4f7fd681-f75a-d1b8-fab2-dd4a44c8b6ca\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"string\",\n \"onboarding_session_super_selection\": {\n \"generated\": {\n \"compliance_letter_url\": \"string\",\n \"super_choice_form_pdf_merged_url\": \"string\",\n \"super_choice_form_pdf_url\": \"string\"\n },\n \"id\": \"f0b22401-351d-5057-2e5e-65190ab0971d\",\n \"outcome\": \"incomplete\",\n \"progress_state\": \"string\",\n \"select_super_fund_product\": {\n \"id\": \"b995393c-33f5-e28f-866a-d861186b16f0\",\n \"is_default_selection\": true,\n \"member_number\": \"string\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"self_managed_super_fund\": {\n \"bank_account_bsb\": \"string\",\n \"bank_account_name\": \"string\",\n \"bank_account_number\": \"string\",\n \"fund_abn\": \"string\",\n \"fund_electronic_service_address\": \"ESUPERFUND\",\n \"fund_name\": \"string\",\n \"id\": \"2ec913dd-bfb5-999f-6637-e991a04155c1\",\n \"member_name\": \"string\",\n \"member_number\": \"string\"\n },\n \"super_fund_member_detail\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"address_line_3\": \"string\",\n \"address_line_4\": \"string\",\n \"date_of_birth\": \"2001-11-22\",\n \"family_name\": \"string\",\n \"gender\": \"male\",\n \"given_name\": \"string\",\n \"id\": \"3bf30ffe-9ff2-5258-9112-41361c119b27\",\n \"locality\": \"string\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"state\": \"\",\n \"tfn\": \"string\",\n \"title\": \"mrs\"\n }\n },\n \"phone_number\": \"string\",\n \"phone_number_validated\": true,\n \"phone_verification\": {\n \"id\": \"08b3e3d2-3280-7d00-f53f-169e343c200a\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"policy_acknowledgements\": {\n \"generated\": [\n {\n \"download_url\": \"https://FLQGNWihVipHZX.czxRatBGMgrBhf6LMWf7CafcjWz,mO9+hIV71GzjnNqIFcSAbKf8\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n {\n \"download_url\": \"https://EuHnDfyjvjSLQcWgtYDFhkxoLHJPmjDC.lmkpOQ71PlBn-RhP\",\n \"policy_acknowledgement_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"id\": \"24448f2f-e74b-75a3-96d9-b2e9351e4bc1\",\n \"outcome\": \"complete_unsuccessful\",\n \"policy_acknowledgements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"inserted_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"acknowledged_at\": \"2024-01-15T10:00:00Z\",\n \"description\": \"This policy outlines how we handle your data.\",\n \"name\": \"Data Privacy Policy\"\n }\n ]\n },\n \"progression\": {\n \"completion_percentage\": 0.75,\n \"is_abandoned\": false\n },\n \"remote_id\": \"string\",\n \"super_disclaimer\": {\n \"accepted_at\": \"string\",\n \"id\": \"4a17d1f6-3f65-0422-0c63-5566fbfe9cf1\",\n \"outcome\": \"complete_unsuccessful\"\n },\n \"target_origin\": \"string\",\n \"template_id\": \"string\",\n \"tfn_declaration\": {\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"id\": \"f091c4fd-aa88-2c2b-0b8d-4af08ada9752\",\n \"outcome\": \"complete_unsuccessful\",\n \"tfn_declaration\": {\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"country_of_origin\": \"twn\",\n \"country_of_origin_alpha_2\": \"string\",\n \"country_of_origin_name\": \"string\",\n \"date_of_birth\": \"1984-09-30\",\n \"declaration_information_accepted\": true,\n \"declaration_stapling_accepted\": false,\n \"declaration_tfnd_accepted\": true,\n \"family_name\": \"string\",\n \"generated\": {\n \"nat_3092_pdf\": \"string\",\n \"nat_74911_pdf\": \"string\",\n \"tfn_declaration_form_pdf\": \"string\"\n },\n \"given_name\": \"string\",\n \"has_financial_supplement_debt\": false,\n \"has_study_and_training_repayment\": true,\n \"id\": \"e574ab84-11c6-3d88-96c9-db8294f3fa5c\",\n \"locality\": \"string\",\n \"middle_name\": \"string\",\n \"pay_basis\": \"\",\n \"postcode\": \"string\",\n \"previous_family_name\": \"string\",\n \"previous_given_name\": \"string\",\n \"residency_type\": \"\",\n \"state\": \"\",\n \"tax_free_threshold_claimed\": true,\n \"tfn\": \"string\",\n \"tfn_exemption_type\": \"pensioner\",\n \"title\": \"ms\"\n }\n }\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc4f4f77-b8a6-4f12-92d5-7d5d2c41cd80", "name": "Error response", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the onboarding session" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"email_validated\": \"\",\n \"employee\": {\n \"remote_id\": \"\"\n },\n \"employee_detail\": {\n \"data\": {\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"id\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"bank_accounts\": [\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n },\n {\n \"account_number\": \"\",\n \"bsb\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"split_kind\": \"\",\n \"split_value\": \"\"\n }\n ],\n \"identity\": {\n \"date_of_birth\": \"2021-02-03\",\n \"family_name\": \"Example\",\n \"gender\": \"other\",\n \"given_name\": \"Test\"\n },\n \"super_details\": {\n \"id\": \"\",\n \"smsf\": {\n \"bank_account_bsb\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"fund_abn\": \"\",\n \"fund_electronic_service_address\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_name\": \"\",\n \"member_number\": \"\"\n },\n \"super_funds\": [\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n },\n {\n \"fund_abn\": \"\",\n \"fund_name\": \"\",\n \"id\": \"\",\n \"member_number\": \"\",\n \"usi\": \"\"\n }\n ]\n },\n \"tax_detail\": {\n \"country_of_origin\": \"\",\n \"employment_type\": \"\",\n \"has_financial_supplement_debt\": \"\",\n \"has_study_and_training_repayment\": \"\",\n \"id\": \"\",\n \"income_type\": \"\",\n \"pay_basis\": \"\",\n \"residency_type\": \"\",\n \"senior_marital_status\": \"\",\n \"tax_free_threshold_claimed\": \"\",\n \"tax_scale_type\": \"\",\n \"tfn\": \"\",\n \"tfn_exemption_type\": \"\",\n \"work_condition\": \"\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"employer\": {\n \"abn\": \"\",\n \"abn_branch_number\": \"\",\n \"accepted_stapling_statement\": false,\n \"accepted_tfn_declaration_statement\": false,\n \"address\": {\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postcode\": \"\",\n \"state\": \"\"\n },\n \"contact\": {\n \"email\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"country\": \"\",\n \"employer_default_super_fund_product\": {\n \"employer_number\": \"\",\n \"id\": \"\",\n \"super_fund_product\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n },\n \"id\": \"\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"last_activity_at\": \"\",\n \"name\": \"\",\n \"onboarding_configuration\": {\n \"default_fund_configured\": \"\",\n \"stapling_enabled\": \"\",\n \"tfnd_enabled\": \"\"\n },\n \"onboarding_status\": \"\",\n \"remote_id\": \"\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"phone_number\": \"\",\n \"phone_number_validated\": \"\",\n \"remote_id\": \"\",\n \"target_origin\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"detail\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fda15131-091e-4bb9-a837-d8cb97120d49", "name": "onboarding_session_embed_url", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8420ddb9-a25c-472e-b8f4-f2cf726be11c", "name": "Generate an embed url for an onboarding session", "request": { "name": "Generate an embed url for an onboarding session", "description": { "content": "Creates an embedded URL used by an iframe to display the onboarding session. For more information regarding the flow, please view [Onboarding Session Embed Flow](https://docs.superapi.com.au/software_partners/how_to_guides/work_with_onboarding_sessions/)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "onboarding-session", ":onboarding_session_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "valid_until", "value": "", "description": "At this datetime the embed will expire and any attempt to load the embed using will fail. Embeds can be used after the expiry time, they just cannot be loaded. This should be a short expiry (around 1 hour)." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "onboarding_session_id", "description": "(Required) The onboarding session id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d0fd6a78-1039-439b-943e-d26ba6766a2c", "name": "Embed url", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":onboarding_session_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2021-12-31T23:59:59Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "onboarding_session_id", "description": "(Required) The onboarding session id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"embed_url\": \"string\"\n },\n \"version\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3b22662-3a69-46c7-99e9-be851ab7b479", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "api", "v1", "onboarding-session", ":onboarding_session_id", "generate-embed-url" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "valid_until", "value": "2021-12-31T23:59:59Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "onboarding_session_id", "description": "(Required) The onboarding session id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"detail\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6311e887-c017-4742-a815-89004b9df9d2", "name": "partner", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8a4b07c5-75cf-4a53-ad28-65c432655fc7", "name": "Get the partner associated with the API key in the header", "request": { "name": "Get the partner associated with the API key in the header", "description": {}, "url": { "path": [ "api", "v1", "partner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{partnerApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9ea53a07-aea5-4e64-9ae2-d1a354614cce", "name": "Partner response", "originalRequest": { "url": { "path": [ "api", "v1", "partner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"name\": \"string\",\n \"custom_css\": \"string\",\n \"id\": \"19c0f328-f06e-0715-9ead-be8166972be0\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"slug\": \"string\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eeeff4dd-da79-46a7-98ce-1e06908d8371", "name": "Upload custom CSS Theme for the partner (DEPRECATED)", "request": { "name": "Upload custom CSS Theme for the partner (DEPRECATED)", "description": {}, "url": { "path": [ "api", "v1", "partner", "custom-theme" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{partnerApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ea276bc5-4115-4a8a-959d-61181525c46c", "name": "Deprecated endpoint", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "custom-theme" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "I'm a teapot (RFC 2324)", "code": 418, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "83a5f3ce-175e-45d0-8271-25b2eda94d7b", "name": "product", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9e8e0190-7dee-4519-8f87-82de306e8bf8", "name": "Get all the products under this partner", "request": { "name": "Get all the products under this partner", "description": {}, "url": { "path": [ "api", "v1", "partner", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{partnerApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cbd2dd32-c20a-4685-9d25-e86fb6b39e9f", "name": "Products response", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"337f4fe9-5a2c-6939-d113-bfa715b1541b\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"target_origin\": \"https://example.com\",\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\",\n \"webhook_url\": \"https://example.com/webhook\"\n },\n {\n \"id\": \"d4b207d6-281f-a956-5cca-554ca1f31b3c\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"target_origin\": \"https://example.com\",\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\",\n \"webhook_url\": \"https://example.com/webhook\"\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa4a035c-2f69-44c4-97bf-2633cda3e1d4", "name": "Create a new product belonging to this partner", "request": { "name": "Create a new product belonging to this partner", "description": {}, "url": { "path": [ "api", "v1", "partner", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{partnerApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"target_origin\": \"\",\n \"webhook_url\": \"\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": \"\",\n \"max_fixed_accounts\": \"\",\n \"max_percentage_accounts\": \"\"\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": \"\"\n },\n \"webhook_signing_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "15d73303-ca78-4d5f-996f-ac32883918d0", "name": "Products response", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Product\",\n \"target_origin\": \"https://example.com\",\n \"webhook_url\": \"https://example.com/webhook\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eefce2ef-bf99-dfcd-0ea1-6389d7bdc898\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"target_origin\": \"https://example.com\",\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\",\n \"webhook_url\": \"https://example.com/webhook\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54ea2228-9458-4901-a689-a4768f4c943f", "name": "Delete a product", "request": { "name": "Delete a product", "description": {}, "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "059bdd0e-edd7-443a-800f-c2293963e734", "name": "An empty response indicating deletion", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f17516b7-bd3b-4b51-bd9d-35aecd10f8a2", "name": "Product was not found", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bad2c19b-0393-4119-b760-16a7b455feab", "name": "Update this product", "request": { "name": "Update this product", "description": { "content": "Updates to the `bank_details_configuration` and `tfn_declaration_configuration` will overwrite their respective existing configurations.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"target_origin\": \"\",\n \"webhook_url\": \"\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": \"\",\n \"max_fixed_accounts\": \"\",\n \"max_percentage_accounts\": \"\"\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": \"\"\n },\n \"webhook_signing_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d9fd4bb8-6226-42b5-8c40-ec4ff8ba0adf", "name": "The changed product", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Product\",\n \"target_origin\": \"https://example.com\",\n \"webhook_url\": \"https://example.com/webhook\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eefce2ef-bf99-dfcd-0ea1-6389d7bdc898\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"target_origin\": \"https://example.com\",\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\",\n \"webhook_url\": \"https://example.com/webhook\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24cb91cb-2043-45c8-bcc8-2c6706907edb", "name": "Product was not found", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Product\",\n \"target_origin\": \"https://example.com\",\n \"webhook_url\": \"https://example.com/webhook\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d8dfe04-6ea3-4608-b901-70603e4c9129", "name": "Update this product", "request": { "name": "Update this product", "description": { "content": "Updates to the `bank_details_configuration` and `tfn_declaration_configuration` will overwrite their respective existing configurations.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"target_origin\": \"\",\n \"webhook_url\": \"\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": \"\",\n \"max_fixed_accounts\": \"\",\n \"max_percentage_accounts\": \"\"\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": \"\"\n },\n \"webhook_signing_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23dd86ca-b425-46af-a49e-a7b127de3296", "name": "The changed product", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Product\",\n \"target_origin\": \"https://example.com\",\n \"webhook_url\": \"https://example.com/webhook\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eefce2ef-bf99-dfcd-0ea1-6389d7bdc898\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"target_origin\": \"https://example.com\",\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\",\n \"webhook_url\": \"https://example.com/webhook\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac568d0-20a1-4dec-ad90-2b3af055651c", "name": "Product was not found", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Product\",\n \"target_origin\": \"https://example.com\",\n \"webhook_url\": \"https://example.com/webhook\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04d968eb-4ffc-476f-9364-54f6c953793d", "name": "Get the product associated with the API key in the header", "request": { "name": "Get the product associated with the API key in the header", "description": {}, "url": { "path": [ "api", "v1", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6fe47c29-615c-494a-80ad-987002920dd0", "name": "Product response", "originalRequest": { "url": { "path": [ "api", "v1", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eefce2ef-bf99-dfcd-0ea1-6389d7bdc898\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"bank_details_configuration\": {\n \"max_bank_accounts\": 3,\n \"max_fixed_accounts\": 1,\n \"max_percentage_accounts\": 2\n },\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"target_origin\": \"https://example.com\",\n \"tfn_declaration_configuration\": {\n \"allow_user_edits\": true\n },\n \"webhook_signing_token\": \"CX9kiN6NYAesyZerpLtNpb4hTqStluCKXOAuJ95QHXCPnJHjH5CJ+Pn/z1XhSd1sMoquJHzhRqc1HSsIXwwDBw==\",\n \"webhook_url\": \"https://example.com/webhook\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d946ae6e-3bd4-4198-bee6-ada1362142c0", "name": "Product was not found", "originalRequest": { "url": { "path": [ "api", "v1", "product" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "35ef77db-6941-4b56-8ca2-0ec837a99111", "name": "product_api_key", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c3f57d5c-75b6-438a-bbcd-4ac2beac1f7b", "name": "Create a new product API key", "request": { "name": "Create a new product API key", "description": {}, "url": { "path": [ "api", "v1", "partner", "product", ":product_id", "product-api-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "product_id", "description": "(Required) The product id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{partnerApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "230a765b-1899-4d15-a242-a5ae4b458ecb", "name": "The created product api key", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":product_id", "product-api-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "product_id", "description": "(Required) The product id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"api_key\": \"string\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6590f414-88a0-48e1-b04a-19febc722ff3", "name": "Delete the given product API key", "request": { "name": "Delete the given product API key", "description": {}, "url": { "path": [ "api", "v1", "partner", "product", ":product_id", "product-api-key", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "product_id", "description": "(Required) The product id" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The product API key id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{partnerApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "90f238cf-b810-4b69-97af-3f404722c832", "name": "The deleted product API Key", "originalRequest": { "url": { "path": [ "api", "v1", "partner", "product", ":product_id", "product-api-key", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "product_id", "description": "(Required) The product id" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The product API key id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"api_key\": \"string\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4dece088-b3eb-40b0-90db-16f5717b65ba", "name": "super_fund_brands", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f73b7237-262b-4331-a4f4-b34f51d7e10c", "name": "Show all available super fund brands", "request": { "name": "Show all available super fund brands", "description": { "content": "Returns a alphabetically sorted list of super fund brands which can be used to define a default super fund for an employee's\nonboarding session.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "super-fund-brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "85f9045e-e189-4093-9d04-5169096bdabd", "name": "Super fund brands list response", "originalRequest": { "url": { "path": [ "api", "v1", "super-fund-brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"3a00009e-be54-3d86-1b42-c57429599461\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"long_description\": \"Example Super is a leading super fund, offering a range of investment options and services to help you grow your retirement savings.\",\n \"name\": \"Example Super\",\n \"product_id\": \"f1b477aa-0f37-4893-8646-1aff2229ce26\",\n \"short_description\": \"Example Super is a leading super fund\",\n \"slug\": \"example-super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n {\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"119c1d22-6b97-ba8f-c5ac-f72c76ebf989\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"long_description\": \"Example Super is a leading super fund, offering a range of investment options and services to help you grow your retirement savings.\",\n \"name\": \"Example Super\",\n \"product_id\": \"f1b477aa-0f37-4893-8646-1aff2229ce26\",\n \"short_description\": \"Example Super is a leading super fund\",\n \"slug\": \"example-super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6464c8a-19bc-41db-9a12-22b25fe02d6e", "name": "Get a single super fund brand by their ID", "request": { "name": "Get a single super fund brand by their ID", "description": { "content": "Returns the super fund brand which can be used to define a default super fund for an employee's\nonboarding session.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "super-fund-brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the super fund brand" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6541a4a1-f78a-4db0-99a8-f6c0e1d03787", "name": "Super fund product", "originalRequest": { "url": { "path": [ "api", "v1", "super-fund-brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the super fund brand" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"e19cb0c3-4581-45ac-b7cd-7af7438b1347\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"long_description\": \"Example Super is a leading super fund, offering a range of investment options and services to help you grow your retirement savings.\",\n \"name\": \"Example Super\",\n \"product_id\": \"f1b477aa-0f37-4893-8646-1aff2229ce26\",\n \"short_description\": \"Example Super is a leading super fund\",\n \"slug\": \"example-super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac0672a2-b1ac-4d19-ba57-d84775a5de11", "name": "Super fund brand was not found", "originalRequest": { "url": { "path": [ "api", "v1", "super-fund-brands", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the super fund brand" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dfe960d3-2e50-4a8c-8490-7cbdeecc8109", "name": "super_fund_products", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "125bf0e1-dbcb-4374-8c0a-3ec02430bc30", "name": "Show all available super fund products", "request": { "name": "Show all available super fund products", "description": { "content": "Returns a alphabetically sorted list of super fund products which can be used to define a default super fund for an employee's\nonboarding session.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "super-fund-products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "50fd88f1-a0ae-4891-84b0-f3f2da2b9f49", "name": "Super fund product list response", "originalRequest": { "url": { "path": [ "api", "v1", "super-fund-products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"803d21b8-bb66-6564-cf74-fed29953f0c2\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n },\n {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"1d2095f9-d7e4-02db-d6fa-4a2ea7bfb55a\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n }\n ],\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "554d7cc9-9fa0-4d7c-b676-0446ee7f8e6d", "name": "Get a single super fund product by their ID", "request": { "name": "Get a single super fund product by their ID", "description": { "content": "Returns the super fund product which can be used to define a default super fund for an employee's\nonboarding session.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "super-fund-products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the super fund product" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bf1c47dc-470e-46b4-adc4-65605d8c50bc", "name": "Super fund product", "originalRequest": { "url": { "path": [ "api", "v1", "super-fund-products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the super fund product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"abn\": \"17011122333\",\n \"homepage_url\": \"https://www.superfund.com.au\",\n \"id\": \"b7f3452c-2da0-563f-8506-f5b204b51662\",\n \"inserted_at\": \"2023-02-01T12:00:00Z\",\n \"name\": \"Example Super\",\n \"updated_at\": \"2023-02-01T12:00:00Z\",\n \"usi_number\": \"STA0999AU\"\n },\n \"version\": \"v1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd07cf7b-1c52-4104-90e1-71866851c36f", "name": "Super fund product was not found", "originalRequest": { "url": { "path": [ "api", "v1", "super-fund-products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The primary key of the super fund product" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/html" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b7de9b0e-6246-4c54-b468-8267733b6700", "name": "upload_saff", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fcb269db-a06b-4e43-8343-c8546f5e4ae6", "name": "Upload a saff file to be processed into an ABA file", "request": { "name": "Upload a saff file to be processed into an ABA file", "description": {}, "url": { "path": [ "api", "v1", "super-send", ":employer_id", "upload-saff" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{productApiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "file", "value": "", "description": "(Required) The contents of the SAFF file" } ] } }, "response": [ { "id": "2cbc7da5-8eea-461d-8e38-cfb181b39e23", "name": "SAFF file upload acknowledgement", "originalRequest": { "url": { "path": [ "api", "v1", "super-send", ":employer_id", "upload-saff" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The contents of the SAFF file", "type": "text/plain" }, "key": "file", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "111e5adc-21d6-4b61-b0d3-6260de5e9a63", "name": "Problem parsing the upload parameters", "originalRequest": { "url": { "path": [ "api", "v1", "super-send", ":employer_id", "upload-saff" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The contents of the SAFF file", "type": "text/plain" }, "key": "file", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.superapi.com.au", "key": "baseUrl" }, { "type": "string", "value": "Product API key", "key": "productApiKey" }, { "type": "string", "value": "Partner API key", "key": "partnerApiKey" } ], "info": { "_postman_id": "7068896a-8488-4641-9f47-d166764bd97d", "name": "SuperApi", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "", "type": "text/plain" } } }