{ "openapi": "3.0.0", "info": { "title": "NCS Licence and Permit API", "description": "API documentation for the Licence and Permit application and renewal portal.", "version": "1.0.0" }, "servers": [ { "url": "/api", "description": "API server" } ], "paths": { "/admin/commands": { "get": { "tags": [ "Admin Configuration" ], "summary": "List commands", "operationId": "60bf8f6271029b80c4177340c095e6ef", "responses": { "200": { "description": "Command list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Configuration" ], "summary": "Create a command", "operationId": "365596714317bef3568011a3f757f475", "responses": { "201": { "description": "Command created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/commands/{command}": { "get": { "tags": [ "Admin Configuration" ], "summary": "Show a command", "operationId": "dae7d739ec44680c8151ba48abd6720b", "parameters": [ { "name": "command", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Command details" } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Admin Configuration" ], "summary": "Update a command", "operationId": "5328963ba1a36e6709ad33a0a189d165", "parameters": [ { "name": "command", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Command updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Configuration" ], "summary": "Partially update a command", "operationId": "b28702a0fb084aac6b6b45c98951fb79", "parameters": [ { "name": "command", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Command updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/document-types": { "get": { "tags": [ "Admin Configuration" ], "summary": "List document types", "operationId": "e512397b2a6310c9867f2da4cf592a24", "responses": { "200": { "description": "Document type list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Configuration" ], "summary": "Create a document type", "operationId": "60b2cea73b46bcf0498ae46c41c210f6", "responses": { "201": { "description": "Document type created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/document-types/{document_type}": { "get": { "tags": [ "Admin Configuration" ], "summary": "Show a document type", "operationId": "10349936e71ff267c3f2836c63817014", "parameters": [ { "name": "document_type", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document type details" } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Admin Configuration" ], "summary": "Update a document type", "operationId": "ae32ce1a2f500fafe0d2b393045d40fd", "parameters": [ { "name": "document_type", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document type updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Configuration" ], "summary": "Partially update a document type", "operationId": "e83bcfa559f7a1f627b728478f47ba5c", "parameters": [ { "name": "document_type", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document type updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/existing-licences": { "get": { "tags": [ "Admin Configuration" ], "summary": "List imported and manually entered existing licences", "operationId": "a73c09a502a91c4cefd426774a9a29eb", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100 } } ], "responses": { "200": { "description": "Existing licence list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Configuration" ], "summary": "Create a manual existing licence record for renewal lookup", "operationId": "e856ea6228536f17a70451416cda3d3a", "responses": { "201": { "description": "Existing licence created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/existing-licences/validate-tin": { "get": { "tags": [ "Admin Configuration" ], "summary": "Validate a company TIN before adding an existing licence", "operationId": "b311122438264427603122e95914f155", "parameters": [ { "name": "tin", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Validated company details" }, "422": { "description": "TIN validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/existing-licences/{existing_licence}": { "put": { "tags": [ "Admin Configuration" ], "summary": "Update an existing licence record used for renewal lookup", "operationId": "97d96ffe3ae15220ae907a75a1364061", "parameters": [ { "name": "existing_licence", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Existing licence updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Configuration" ], "summary": "Partially update an existing licence record used for renewal lookup", "operationId": "20a8eed8ce7e9eb461be980a6fc490c7", "parameters": [ { "name": "existing_licence", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Existing licence updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/existing-licences/{existing_licence}/activate": { "post": { "tags": [ "Admin Configuration" ], "summary": "Activate an existing licence for Bodogwu onboarding lookup", "operationId": "7c1a970b221d883bddb03d909d080c70", "parameters": [ { "name": "existing_licence", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Existing licence activated for onboarding" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/lookup": { "get": { "tags": [ "Admin" ], "summary": "Admin lookup for company and field agents by TIN", "operationId": "c26ed5cbeba7550311285d4d79fe980f", "parameters": [ { "name": "tin", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "command_id", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding lookup result" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/requests": { "get": { "tags": [ "Admin" ], "summary": "Admin list of onboarding requests", "operationId": "9e655934bf3ff4020f0acfc13cfd6592", "responses": { "200": { "description": "Onboarding requests" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/field-agents": { "post": { "tags": [ "Admin" ], "summary": "Admin create a TIN-linked field agent for onboarding", "operationId": "98474281083396b89944cea20933d0c5", "responses": { "201": { "description": "Field agent created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/field-agents/{fieldAgent}": { "put": { "tags": [ "Admin" ], "summary": "Admin update a new-system field agent before Bodogwu transmission", "operationId": "4672d31b38755c12aae8c94b24399e66", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent updated" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin" ], "summary": "Admin partially update a new-system field agent before Bodogwu transmission", "operationId": "9c9a1879a4cfdceea65d82cefd159d28", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent updated" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/legacy-field-agents/{legacyFieldAgent}": { "put": { "tags": [ "Admin" ], "summary": "Admin update an imported legacy field agent before Bodogwu transmission", "operationId": "b673dddcb36a14f1ec69173dc05703bb", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Legacy field agent updated" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin" ], "summary": "Admin partially update an imported legacy field agent before Bodogwu transmission", "operationId": "dd262eea25d6d2b4f68cfe94e0e9b315", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Legacy field agent updated" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/field-agents/{fieldAgent}/requests": { "post": { "tags": [ "Admin" ], "summary": "Admin create an onboarding request for a new-system field agent and selected command", "operationId": "a0bf66895bab176fc1417d9747a788fc", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Onboarding request created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/legacy-field-agents/{legacyFieldAgent}/requests": { "post": { "tags": [ "Admin" ], "summary": "Admin create an onboarding request for a legacy field agent and selected command", "operationId": "add87340d9221ce60ef69b1b8d455f0e", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Onboarding request created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/field-agents/{fieldAgent}/payload-preview": { "post": { "tags": [ "Admin" ], "summary": "Admin preview the Bodogwu payload for a new-system field agent and selected command", "operationId": "60be585ec2f75dde73af882995b2898c", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/field-agents/{fieldAgent}/block-payload-preview": { "post": { "tags": [ "Admin" ], "summary": "Admin preview a Bodogwu block payload for a new-system field agent and selected command", "operationId": "cbc425b8083883fb65107f413a832fff", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu block payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/field-agents/{fieldAgent}/block-transmit": { "post": { "tags": [ "Admin" ], "summary": "Admin transmit a Bodogwu block status update for a new-system field agent", "operationId": "b693abea1898d777a49ffc6a33cb5c4a", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Block transmission attempted" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/legacy-field-agents/{legacyFieldAgent}/payload-preview": { "post": { "tags": [ "Admin" ], "summary": "Admin preview the Bodogwu payload for a legacy field agent and selected command", "operationId": "d58486a3cb3bc9c979c1aca176e0a832", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/legacy-field-agents/{legacyFieldAgent}/block-payload-preview": { "post": { "tags": [ "Admin" ], "summary": "Admin preview a Bodogwu block payload for a legacy field agent and selected command", "operationId": "85b406386a514993a4efb690971276c8", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu block payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/legacy-field-agents/{legacyFieldAgent}/block-transmit": { "post": { "tags": [ "Admin" ], "summary": "Admin transmit a Bodogwu block status update for a legacy field agent", "operationId": "e25412b628d62c093ead26aa076762b6", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Block transmission attempted" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/requests/{onboardingRequest}/payload": { "get": { "tags": [ "Admin" ], "summary": "Admin preview the Bodogwu payload for a saved onboarding request", "operationId": "6e2bb034eaabb882256d3f6ad77c5cb9", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/requests/{onboardingRequest}/transmit": { "post": { "tags": [ "Admin" ], "summary": "Admin transmit or retransmit an onboarding request to Bodogwu", "operationId": "114a62a0bda7b74db1e1bec37e761efa", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Transmission attempted" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/requests/{onboardingRequest}/approve": { "post": { "tags": [ "Admin" ], "summary": "Admin approve an onboarding request", "operationId": "fd510d1af12a14718d2bbcf7efe38ced", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding request approved" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/requests/{onboardingRequest}/query": { "post": { "tags": [ "Admin" ], "summary": "Admin query an onboarding request", "operationId": "40e68d2560929de05eeee58c902a386d", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding request queried" } }, "security": [ { "sanctum": [] } ] } }, "/admin/onboarding/requests/{onboardingRequest}/decline": { "post": { "tags": [ "Admin" ], "summary": "Admin decline an onboarding request", "operationId": "86435154406c97e46ca7fd32ed30415f", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding request declined" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-serial-setting": { "get": { "tags": [ "Admin Configuration" ], "summary": "Show licence serial control setting", "operationId": "b524eec489b79e3d7a31c5bfdd8c587b", "responses": { "200": { "description": "Licence serial setting" } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Admin Configuration" ], "summary": "Update licence serial control setting", "operationId": "f12b988e8b7fd50542ae565af6fd0950", "responses": { "200": { "description": "Licence serial setting updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types/{licenceType}/document-requirements": { "put": { "tags": [ "Admin Configuration" ], "summary": "Update document requirements for a licence type", "operationId": "e6b53a68ddf58c1bb56982c825855cbb", "parameters": [ { "name": "licenceType", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document requirements updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types/{licenceType}/workflow-settings": { "put": { "tags": [ "Admin Configuration" ], "summary": "Update workflow settings for a licence type", "operationId": "fa9d9c0c4fe1cdae70336d4ef615f249", "parameters": [ { "name": "licenceType", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Workflow settings updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types/{licenceType}/fees": { "put": { "tags": [ "Admin Configuration" ], "summary": "Update fees for a licence type", "operationId": "1db467e502bec297e331a09718d7b455", "parameters": [ { "name": "licenceType", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Fees updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types/{licenceType}/other-fees": { "put": { "tags": [ "Admin Configuration" ], "summary": "Update other fees for a licence type", "operationId": "b90115315f5b0485004c7c8ddfdae0d5", "parameters": [ { "name": "licenceType", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Other fees updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types/{licenceType}/bonds": { "put": { "tags": [ "Admin Configuration" ], "summary": "Update bond settings for a licence type", "operationId": "2497ae615e3068ebe9b497f162252060", "parameters": [ { "name": "licenceType", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond settings updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types": { "get": { "tags": [ "Admin Configuration" ], "summary": "List licence and permit types", "operationId": "7f607e1b83a7e5965c6039f0799f22f6", "responses": { "200": { "description": "Licence type list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Configuration" ], "summary": "Create a licence or permit type", "operationId": "54a005b06ac1a83849f47920ce8d48d4", "responses": { "201": { "description": "Licence type created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/licence-types/{licence_type}": { "get": { "tags": [ "Admin Configuration" ], "summary": "Show a licence or permit type", "operationId": "4f33a394be013a9be754a895239160e6", "parameters": [ { "name": "licence_type", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Licence type details" } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Admin Configuration" ], "summary": "Update a licence or permit type", "operationId": "567065a344cf9619696e3342565e2fed", "parameters": [ { "name": "licence_type", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Licence type updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Configuration" ], "summary": "Partially update a licence or permit type", "operationId": "f2b2f46bfcab6537176b3dad40dd9557", "parameters": [ { "name": "licence_type", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Licence type updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/overview-counts": { "get": { "tags": [ "Admin Configuration" ], "summary": "Get admin overview and navigation counts", "operationId": "5eb8be18de708bc6f42341b7dfe7b129", "responses": { "200": { "description": "Admin overview counts" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/applicants": { "get": { "tags": [ "Admin Users" ], "summary": "List applicant users", "operationId": "1674ad195314f77ea2c0edfa84d79865", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "active", "inactive" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Applicant user list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Users" ], "summary": "Create an applicant user", "operationId": "1720588647fbcdd37b656f0eb4befaae", "responses": { "201": { "description": "Applicant user created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/applicants/{user}": { "put": { "tags": [ "Admin Users" ], "summary": "Update an applicant user", "operationId": "e3f774d68c3bc875f6e2c51081afa3b5", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Applicant user updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Users" ], "summary": "Partially update an applicant user", "operationId": "eb6e9bfb00be28cbe88bc2dfee5449e0", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Applicant user updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/officers": { "get": { "tags": [ "Admin Users" ], "summary": "List officer users", "operationId": "f0ec0bffec253a54d30d2a02f087e52e", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "active", "inactive" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Officer user list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Users" ], "summary": "Create an officer user", "operationId": "2152574bb882c704e24f560510d60bb5", "responses": { "201": { "description": "Officer user created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/officers/{user}": { "put": { "tags": [ "Admin Users" ], "summary": "Update an officer user", "operationId": "5deef3a5d3b7284af89141733d19cb9c", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Officer user updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Users" ], "summary": "Partially update an officer user", "operationId": "aa84d1cf7768ec54ec135096f18f9473", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Officer user updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/integrations": { "get": { "tags": [ "Admin Users" ], "summary": "List API integration users", "operationId": "f67cdf4d794150f91ee9a58bee7406c0", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "active", "inactive" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "API integration user list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Admin Users" ], "summary": "Create an API integration user", "operationId": "33b2c4095ea64aa396e14913f127c0ee", "responses": { "201": { "description": "API integration user created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/integrations/{user}": { "put": { "tags": [ "Admin Users" ], "summary": "Update an API integration user", "operationId": "0befebc4e23eb9067c99f8f79ad8cddb", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "API integration user updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Admin Users" ], "summary": "Partially update an API integration user", "operationId": "98d9cd79661814fec12eaf38cc1c0b5d", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "API integration user updated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/{user}/password-reset": { "post": { "tags": [ "Admin Users" ], "summary": "Send a password reset link to a managed user", "operationId": "f8e7b8396ef8293ace224a1535aa3244", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Password reset email queued" }, "404": { "description": "User not found" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/roles": { "get": { "tags": [ "Admin Users" ], "summary": "List roles available for admin user management", "operationId": "5773d6dba71ee7393544d5234cd66074", "responses": { "200": { "description": "Role list" } }, "security": [ { "sanctum": [] } ] } }, "/admin/users/ranks": { "get": { "tags": [ "Admin Users" ], "summary": "List ranks available for officer profiles", "operationId": "1ca533f79d8b0ce9aacfe09747c196cd", "responses": { "200": { "description": "Rank list" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications": { "get": { "tags": [ "Applicant" ], "summary": "List applicant licence applications", "operationId": "d11ec1ef2caee9a48a19cf8e43efb019", "responses": { "200": { "description": "Applicant application list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Applicant" ], "summary": "Create an applicant licence application entry", "operationId": "4d8c628a51894421f5ebe670ff8d2934", "responses": { "201": { "description": "Application created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/documents": { "get": { "tags": [ "Applicant" ], "summary": "Show document upload checklist for an applicant application", "operationId": "59be90e6f3c099e7ba54a56d479bd195", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application document checklist" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/documents/{requirement}": { "post": { "tags": [ "Applicant" ], "summary": "Upload or replace an applicant application document", "operationId": "3ae3da464f09478daa0284cee2cb3eeb", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "requirement", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document uploaded" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/documents/{document}/file": { "get": { "tags": [ "Applicant" ], "summary": "View an uploaded applicant document", "operationId": "49d734d517714afa4aeef19c1331c5e6", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Uploaded document file" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/submit": { "post": { "tags": [ "Applicant" ], "summary": "Submit an applicant application for review after document upload", "operationId": "c8c3c1692e60ba02d6f1ad7be1dd7a28", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application submitted" }, "422": { "description": "Missing mandatory documents" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/directors": { "get": { "tags": [ "Applicant" ], "summary": "List applicant directors", "operationId": "6cd5021866fca5b34e198dbfa1073f13", "responses": { "200": { "description": "Director list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Applicant" ], "summary": "Create an applicant director", "operationId": "c8f65099d7fa09db4620206bb98cfa84", "responses": { "201": { "description": "Director created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/directors/{director}": { "put": { "tags": [ "Applicant" ], "summary": "Update a pending or queried applicant director", "operationId": "0823021694737814a0c68cae2aeb6c89", "parameters": [ { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director updated" }, "403": { "description": "Director not editable" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Applicant" ], "summary": "Remove a pending or queried applicant director", "operationId": "f6b30dd1bd0d0fa56c48384979272958", "parameters": [ { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director removed" }, "403": { "description": "Director not removable" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Applicant" ], "summary": "Partially update a pending or queried applicant director", "operationId": "7a8a1030668da1351cf1720fb80b61de", "parameters": [ { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director updated" }, "403": { "description": "Director not editable" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/directors/{director}/passport": { "get": { "tags": [ "Applicant" ], "summary": "View applicant director passport", "operationId": "82570079ff1641ee7cfcd4b86313a605", "parameters": [ { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Passport image" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/document-requirements": { "get": { "tags": [ "Applicant" ], "summary": "List document requirements for active licence and permit types", "operationId": "1ac979965b72d8f3c3859e86df225386", "responses": { "200": { "description": "Applicant document requirement catalogue" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/field-agents": { "get": { "tags": [ "Applicant" ], "summary": "List applicant field agents", "operationId": "4813a17e8d9a28c303c18829b99b76f4", "responses": { "200": { "description": "Field agent list" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Applicant" ], "summary": "Create an applicant field agent without creating a login account", "operationId": "2946c17f89003772d7306815e1bb35b0", "responses": { "201": { "description": "Field agent created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/field-agents/{fieldAgent}": { "put": { "tags": [ "Applicant" ], "summary": "Update a pending or queried applicant field agent", "operationId": "5d18443161ca98e507d7c8f4eb50db8b", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent updated" }, "403": { "description": "Field agent not editable" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Applicant" ], "summary": "Remove a pending or queried applicant field agent", "operationId": "f1c571d714bafa10f951ae2a6ff9ea6d", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent removed" }, "403": { "description": "Field agent not removable" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Applicant" ], "summary": "Partially update a pending or queried applicant field agent", "operationId": "a54f92819225ad79a7df536ac6677d7a", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent updated" }, "403": { "description": "Field agent not editable" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/field-agents/{fieldAgent}/passport": { "get": { "tags": [ "Applicant" ], "summary": "View applicant field agent passport", "operationId": "d648c98b83087a56fccf36a6ba0a6d88", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Passport image" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/field-agents/{fieldAgent}/onboarding-requests": { "post": { "tags": [ "Applicant" ], "summary": "Request Bodogwu onboarding for an applicant field agent", "operationId": "020cc84dba8d70710078c3af1fe78ee9", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Onboarding request created" }, "403": { "description": "Field agent does not belong to applicant" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/legacy-field-agents/{legacyFieldAgent}/onboarding-requests": { "post": { "tags": [ "Applicant" ], "summary": "Request Bodogwu onboarding for an imported legacy field agent", "operationId": "145962b1f83758a7accb12ad0c18df24", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Onboarding request created" }, "403": { "description": "Legacy field agent does not belong to applicant company" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/licence-application-options": { "get": { "tags": [ "Applicant" ], "summary": "List applicant licence application options and existing licence lookup", "operationId": "9b94ca067e4d1ecfc6bfebc18864d7f4", "responses": { "200": { "description": "Licence application options" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/licence-types": { "get": { "tags": [ "Applicant" ], "summary": "List active licence and permit types available to applicants", "operationId": "c7a1fc8390a4e66469f2950770d339aa", "responses": { "200": { "description": "Applicant licence and permit catalogue" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/payment": { "get": { "tags": [ "Applicant" ], "summary": "Show applicant payment and bond submission form", "operationId": "e1473c9db12c29afb18721899551e3f2", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment summary" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Applicant" ], "summary": "Upload applicant bond document before payment assessment", "operationId": "8d169c57a7bde97e6af074d360dd924f", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond document uploaded" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/payment/assessment": { "post": { "tags": [ "Applicant" ], "summary": "Generate Bodogwu payment assessment notice", "operationId": "087ff7409e759c82c0f90e038f433190", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Assessment notice generated" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/payment/assessment-notice": { "get": { "tags": [ "Applicant" ], "summary": "Download generated Bodogwu assessment notice PDF", "operationId": "87a18b00079768fd49fa3eddbc5153f8", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Assessment notice PDF" }, "404": { "description": "Assessment notice not found" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/payment/evidence": { "get": { "tags": [ "Applicant" ], "summary": "View applicant payment evidence file", "operationId": "1900d472222d607598bba9cda28fd829", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment evidence file" }, "404": { "description": "Payment evidence not found" } }, "security": [ { "sanctum": [] } ] } }, "/applicant/applications/{application}/payment/bond-document": { "get": { "tags": [ "Applicant" ], "summary": "View applicant bond document file", "operationId": "ab49c878d87615a9a0ac3a7c13fae7f8", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond document file" }, "404": { "description": "Bond document not found" } }, "security": [ { "sanctum": [] } ] } }, "/register": { "post": { "tags": [ "Auth" ], "summary": "Register an applicant account", "operationId": "5d4fa5d5607ed675ba93907e1fc94534", "responses": { "201": { "description": "Applicant account created" }, "422": { "description": "Validation error" } } } }, "/password/setup": { "post": { "tags": [ "Auth" ], "summary": "Complete applicant password setup", "operationId": "578bb6849ce7d35af9106501d8d5ec0f", "responses": { "200": { "description": "Password setup complete" }, "422": { "description": "Invalid or expired token" } } } }, "/password/recover-tin": { "post": { "tags": [ "Auth" ], "summary": "Send an applicant password recovery link using company TIN", "operationId": "953734a3915998ea8b7dc9c3c16bddc6", "responses": { "200": { "description": "Password recovery email queued" }, "422": { "description": "TIN not found or email could not be sent" } } } }, "/login": { "post": { "tags": [ "Auth" ], "summary": "Login and create a Sanctum token", "description": "Authenticates a portal or API integration account and returns the Bearer token used on protected endpoints.", "operationId": "67d6d0fdd54fba132e1b6f55ca254183", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email", "example": "bodogwu.integration@example.com" }, "password": { "type": "string", "format": "password", "example": "integration-account-password" } }, "type": "object" } } } }, "responses": { "200": { "description": "Login successful", "content": { "application/json": { "schema": { "properties": { "user": { "type": "object" }, "token": { "description": "Use as the Bearer token on authenticated requests.", "type": "string", "example": "1|generated-plain-text-token" } }, "type": "object" } } } }, "422": { "description": "Credentials are invalid or the account is inactive" } } } }, "/me": { "get": { "tags": [ "Auth" ], "summary": "Get the authenticated user", "operationId": "bc2032a379aa97707ccc61511897c120", "responses": { "200": { "description": "Authenticated user details" }, "401": { "description": "Unauthenticated" } }, "security": [ { "sanctum": [] } ] } }, "/me/password-reset": { "post": { "tags": [ "Auth" ], "summary": "Send a password reset link to the authenticated user", "operationId": "4f8a59e6aaa43a213c15899c1237f128", "responses": { "200": { "description": "Password reset email queued" }, "401": { "description": "Unauthenticated" } }, "security": [ { "sanctum": [] } ] } }, "/logout": { "post": { "tags": [ "Auth" ], "summary": "Delete the current Sanctum token", "operationId": "28d48c13fca984400ac8de99f54ee13a", "responses": { "200": { "description": "Logged out" }, "401": { "description": "Unauthenticated" } }, "security": [ { "sanctum": [] } ] } }, "/bodogwu/payments/status": { "post": { "tags": [ "Bodogwu" ], "summary": "Receive Bodogwu payment status update", "description": "Marks a Bodogwu assessment as paid. Requires a Bearer token issued to an active api_integration account.", "operationId": "ac635705d003cb4ee2f15e4ad9d79971", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "assessment_number", "status" ], "properties": { "assessment_number": { "description": "Exact assessment notice number generated by Bodogwu.", "type": "string", "example": "B202601ZAL80" }, "status": { "type": "string", "example": "paid", "enum": [ "paid", "success", "successful", "completed" ] }, "paid_at": { "description": "Optional payment time. Server time is used when omitted.", "type": "string", "format": "date-time", "example": "2026-10-05T14:35:20+01:00" } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment status updated", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "application_id": { "type": "integer", "example": 4 }, "reference_number": { "type": "string", "example": "NCS/01AP/CA01/26/3" }, "application_status": { "type": "string", "example": "submitted" }, "applicant_name": { "type": "string", "example": "NABILA OIL MILLS (NIG) LTD" }, "applicant_tin": { "type": "string", "example": "2522095098753" }, "payment_id": { "type": "integer", "example": 5 }, "invoice_number": { "type": "string", "example": "LP-01AP-CA01-26-3" }, "assessment_notice_number": { "type": "string", "example": "B202601ZAL80" }, "assessment_status": { "type": "string", "example": "paid" }, "payment_status": { "type": "string", "example": "approved" } }, "type": "object" }, "email_sent": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Payment status updated successfully." } }, "type": "object" } } } }, "401": { "description": "Bearer token is missing, invalid, or expired" }, "403": { "description": "Authenticated user is not an integration user" }, "404": { "description": "Assessment notice number was not found" }, "422": { "description": "Assessment number is missing or status is not a supported successful status" } }, "security": [ { "sanctum": [] } ] } }, "/certificates/verify/{code}": { "get": { "tags": [ "Certificates" ], "summary": "Publicly verify an issued certificate", "operationId": "b09eeeb39d2bd9c64a8a393ab23de659", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Certificate verification result" }, "404": { "description": "Certificate not found" } } } }, "/command/applications": { "get": { "tags": [ "Command" ], "summary": "List applications waiting for command review", "operationId": "23ce0b95f0010391495a894a8d669695", "responses": { "200": { "description": "Command review queue" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}": { "get": { "tags": [ "Command" ], "summary": "Show command application file", "operationId": "b62a43c64c41f1a2e6280eeba579558e", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Command application file" }, "404": { "description": "Application not available to officer" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/documents/{document}/file": { "get": { "tags": [ "Command" ], "summary": "View an uploaded applicant document during command review", "operationId": "5d98de8d9264c4a8ad8ba527809c0261", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Uploaded document file" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/directors/{director}/passport": { "get": { "tags": [ "Command" ], "summary": "View an applicant director passport during command review", "operationId": "63f130f7c766a1c99c1dcd9afbc723d0", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director passport image" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/payment/evidence": { "get": { "tags": [ "Command" ], "summary": "View payment evidence during command review", "operationId": "0e367bb0099f2e0c608dc90c3f259435", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment evidence file" }, "404": { "description": "Payment evidence not found" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/payment/bond-document": { "get": { "tags": [ "Command" ], "summary": "View bond document during command review", "operationId": "ce286fd5ae8d714ae576b03ca140ec64", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond document file" }, "404": { "description": "Bond document not found" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/directors/{director}/approve": { "post": { "tags": [ "Command" ], "summary": "Approve an applicant director during Bond Seat review", "operationId": "91c39967c0977cedc09132038f9f48f9", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director approved" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/directors/{director}/query": { "post": { "tags": [ "Command" ], "summary": "Query an applicant director during Bond Seat review", "operationId": "e96daa9d2b9ac2349a203a8690efc5e8", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director queried" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/documents/{document}/approve": { "post": { "tags": [ "Command" ], "summary": "Approve an uploaded document during Bond Seat review", "operationId": "ebabf770f63064cb941f484ecc16bb9c", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document approved" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/documents/{document}/query": { "post": { "tags": [ "Command" ], "summary": "Query an uploaded document during Bond Seat review", "operationId": "162519514b43a0f7a25f8c59734c1ebf", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document queried" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/inspection-report": { "post": { "tags": [ "Command" ], "summary": "Create or update a Bond Seat inspection report", "operationId": "474232b9069f3f838ad2e3cfcb37c8c7", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Inspection report saved" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/forward-to-hq": { "post": { "tags": [ "Command" ], "summary": "Forward a Bond Seat-reviewed application to HQ review", "operationId": "78bfa7661e37363e62275bcd3d851a3e", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application forwarded to HQ" }, "422": { "description": "Pending item validation" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/query": { "post": { "tags": [ "Command" ], "summary": "Query a Bond Seat application file", "operationId": "5eb48969aaf3f43e4f6560f6f5346d4c", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application queried" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/forward-to-bond-seat": { "post": { "tags": [ "Command" ], "summary": "Forward a Review Officer application to Bond Seat review", "operationId": "685745ebe67ca948752c76ab608bbab5", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application forwarded to Bond Seat" }, "403": { "description": "Officer not allowed" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/payment/approve": { "post": { "tags": [ "Command" ], "summary": "Approve applicant payment assessment during Accounts review", "operationId": "e44e770a569d2e47f15637c5439c8765", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment approved" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/payment/query": { "post": { "tags": [ "Command" ], "summary": "Query applicant payment assessment during Accounts review", "operationId": "4d31364f5d7c876503af49010a06a77a", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment queried" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/payment/bond/validate": { "post": { "tags": [ "Command" ], "summary": "Validate bond document during Bond Seat post-payment review", "operationId": "72845397ed0e081e2c1926e7bbbc7c68", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond document validated" } }, "security": [ { "sanctum": [] } ] } }, "/command/applications/{application}/payment/bond/query": { "post": { "tags": [ "Command" ], "summary": "Query bond document during Bond Seat post-payment review", "operationId": "36760dbf79ab5e2842483d6bc40f75b7", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond document queried" } }, "security": [ { "sanctum": [] } ] } }, "/command/active-licences": { "get": { "tags": [ "Command" ], "summary": "List active licences issued through the logged-in officer command", "operationId": "ff48a2c2bbc9b7dd6a3566d6aa5d6ca2", "responses": { "200": { "description": "Active command licence list" } }, "security": [ { "sanctum": [] } ] } }, "/command/active-c30": { "get": { "tags": [ "Command" ], "summary": "List companies with active field agents in the logged-in officer command", "operationId": "5b269beb216473dc48bb47a35bfb886a", "responses": { "200": { "description": "Active command C30 list" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/lookup": { "get": { "tags": [ "Command" ], "summary": "Resolve company and field agents by TIN for Bond Seat onboarding", "operationId": "2a2d5dcdac08ed93e2f78f2ef1b3b1ef", "parameters": [ { "name": "tin", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Onboarding lookup result" }, "404": { "description": "TIN not found" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/requests": { "get": { "tags": [ "Command" ], "summary": "List Bond Seat onboarding requests for the logged-in command", "operationId": "d74bdd168fe7ff0e1f0d942b6d4ba6f0", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "requested_by_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100 } } ], "responses": { "200": { "description": "Onboarding request list" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/field-agents": { "post": { "tags": [ "Command" ], "summary": "Create a TIN-linked field agent from Bond Seat onboarding", "operationId": "6d0b1aa772f09e140b9f31e40ba35bf2", "responses": { "201": { "description": "Field agent created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/field-agents/{fieldAgent}": { "put": { "tags": [ "Command" ], "summary": "Update a command-created field agent before Bodogwu transmission", "operationId": "b8d5202096cd4db76094faf369335462", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent updated" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Command" ], "summary": "Partially update a command-created field agent before Bodogwu transmission", "operationId": "52491c814935b8d98c870a6e1952ca07", "parameters": [ { "name": "fieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Field agent updated" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/field-agents/{field_agent}/requests": { "post": { "tags": [ "Command" ], "summary": "Create a Bond Seat onboarding request for a field agent", "operationId": "fcc5c36a4aa222a7177f6a6e45a09a55", "parameters": [ { "name": "field_agent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Onboarding request created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/field-agents/{field_agent}/payload-preview": { "post": { "tags": [ "Command" ], "summary": "Preview the Bodogwu payload for a new-system field agent", "operationId": "5309cc10cc232fa35fac218b74db36e1", "parameters": [ { "name": "field_agent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/field-agents/{field_agent}/block-payload-preview": { "post": { "tags": [ "Command" ], "summary": "Preview a Bodogwu block payload for a new-system field agent", "operationId": "cb14a9eb4ea96bdab2de9774c2d52d9e", "parameters": [ { "name": "field_agent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu block payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/field-agents/{field_agent}/block-transmit": { "post": { "tags": [ "Command" ], "summary": "Transmit a Bodogwu block status update for a new-system field agent", "operationId": "ae814d9d7f195d57a6e6bab2cabbd925", "parameters": [ { "name": "field_agent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Block transmission attempted" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/legacy-field-agents/{legacyFieldAgent}/requests": { "post": { "tags": [ "Command" ], "summary": "Create a Bond Seat onboarding request for an imported legacy field agent", "operationId": "238c76a5fc8a827cc93e258d9d2c8049", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Onboarding request created" }, "422": { "description": "Validation error" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/legacy-field-agents/{legacyFieldAgent}": { "put": { "tags": [ "Command" ], "summary": "Update an imported legacy field agent before Bodogwu transmission", "operationId": "6927fe1b90ebb5f06034ba2f716b3c2b", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Legacy field agent updated" } }, "security": [ { "sanctum": [] } ] }, "patch": { "tags": [ "Command" ], "summary": "Partially update an imported legacy field agent before Bodogwu transmission", "operationId": "651aa8ef8823838971ec7f3c5bf24bef", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Legacy field agent updated" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/legacy-field-agents/{legacyFieldAgent}/payload-preview": { "post": { "tags": [ "Command" ], "summary": "Preview the Bodogwu payload for an imported legacy field agent", "operationId": "20fb8d7e0c61ba36ff49f274f7553314", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/legacy-field-agents/{legacyFieldAgent}/block-payload-preview": { "post": { "tags": [ "Command" ], "summary": "Preview a Bodogwu block payload for an imported legacy field agent", "operationId": "4f39d77a1e3f8e22826573b45882244e", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu block payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/legacy-field-agents/{legacyFieldAgent}/block-transmit": { "post": { "tags": [ "Command" ], "summary": "Transmit a Bodogwu block status update for an imported legacy field agent", "operationId": "ad38041fafaec7080eda1b98c436ee44", "parameters": [ { "name": "legacyFieldAgent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Block transmission attempted" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/requests/{onboardingRequest}/transmit": { "post": { "tags": [ "Command" ], "summary": "Transmit or retransmit a field agent onboarding request to Bodogwu", "operationId": "1ec3cbd75cd4122c6b5ec0b7c1447092", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Transmission attempted" }, "403": { "description": "Invalid command access" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/requests/{onboardingRequest}/payload": { "get": { "tags": [ "Command" ], "summary": "Preview the Bodogwu payload for an onboarding request", "operationId": "c3a856e40214b0ba6a19e4d751eb42e9", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bodogwu payload preview" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/requests/{onboardingRequest}/approve": { "post": { "tags": [ "Command" ], "summary": "Approve a Bond Seat onboarding request after review or successful transmission", "operationId": "f9d04880463739b8e5a6e0125212c871", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding request approved" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/requests/{onboardingRequest}/query": { "post": { "tags": [ "Command" ], "summary": "Query an applicant-submitted onboarding request", "operationId": "127e2fd032b8b5305d1dfeb4c8b2ffbe", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding request queried" } }, "security": [ { "sanctum": [] } ] } }, "/command/onboarding/requests/{onboardingRequest}/decline": { "post": { "tags": [ "Command" ], "summary": "Decline an applicant-submitted onboarding request", "operationId": "6e762bc1b79b01bdd5fd6834127124a1", "parameters": [ { "name": "onboardingRequest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Onboarding request declined" } }, "security": [ { "sanctum": [] } ] } }, "/command/menu-counts": { "get": { "tags": [ "Command" ], "summary": "Get command workspace navigation badge counts", "operationId": "ec2ca61d9642869239008c1606e78e1e", "responses": { "200": { "description": "Command menu counts" } }, "security": [ { "sanctum": [] } ] } }, "/health": { "get": { "tags": [ "System" ], "summary": "Check API health", "operationId": "f01348cd43f5a168b9969a9386b92dae", "responses": { "200": { "description": "API is available", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "ok" }, "service": { "type": "string", "example": "NCS Licence and Permit API" } }, "type": "object" } } } } } } }, "/hq/applications": { "get": { "tags": [ "HQ" ], "summary": "List applications waiting for HQ review", "operationId": "65a5bc860317377539af083626b7ffe2", "responses": { "200": { "description": "HQ review queue" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}": { "get": { "tags": [ "HQ" ], "summary": "Show HQ application file", "operationId": "b710da45cce031cdb2528f6af4ee4f26", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "HQ application file" }, "404": { "description": "Application not available to HQ officer" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/documents/{document}/file": { "get": { "tags": [ "HQ" ], "summary": "View an uploaded applicant document during HQ review", "operationId": "34e4ca523e96bfb714584ec389bed9cb", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "document", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Uploaded document file" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/directors/{director}/passport": { "get": { "tags": [ "HQ" ], "summary": "View an applicant director passport during HQ review", "operationId": "fe34e885ccf8ecd0d223ff07f52eebf7", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "director", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Director passport image" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/payment/evidence": { "get": { "tags": [ "HQ" ], "summary": "View payment evidence during HQ review", "operationId": "37d6ee540a0ceaa2139a435973b758a6", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment evidence file" }, "404": { "description": "Payment evidence not found" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/payment/bond-document": { "get": { "tags": [ "HQ" ], "summary": "View bond document during HQ review", "operationId": "b01e84bd1711b885293f6dc4baf5d974", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Bond document file" }, "404": { "description": "Bond document not found" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/approve-for-payment": { "post": { "tags": [ "HQ" ], "summary": "Approve a first-stage HQ application for applicant payment", "operationId": "79e2c34bc7ad1835957a4a272d73b3fb", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application approved for payment" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/forward-to-validator": { "post": { "tags": [ "HQ" ], "summary": "Forward a final HQ-reviewed application to validation", "operationId": "2492eae36b5e7fc1168d8c1edcebb3a4", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application forwarded to validator" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/validate": { "post": { "tags": [ "HQ" ], "summary": "Validate an application and generate or retain the licence number", "operationId": "eafef4cfb348bb26f456bb397a419728", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application validated" }, "422": { "description": "Licence number generation failed" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/approve-issuance": { "post": { "tags": [ "HQ" ], "summary": "Complete Comptroller L&P final approval and issue the licence", "operationId": "44815ca6562e77e6b4ea3b52393e5058", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Licence issued" }, "422": { "description": "Licence number missing" } }, "security": [ { "sanctum": [] } ] } }, "/hq/applications/{application}/query": { "post": { "tags": [ "HQ" ], "summary": "Query a first-stage HQ application file", "operationId": "2141ead8c3e33e96ffa0195643ee506e", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application queried" } }, "security": [ { "sanctum": [] } ] } }, "/hq/congratulatory-letters": { "get": { "tags": [ "HQ" ], "summary": "List generated HQ congratulatory letters", "operationId": "f4ff4a1c65e908bff162ca0a1f8ad0ab", "responses": { "200": { "description": "Generated congratulatory letters" } }, "security": [ { "sanctum": [] } ] } }, "/hq/congratulatory-letters/{letter}": { "get": { "tags": [ "HQ" ], "summary": "Show generated HQ congratulatory letter", "operationId": "ea8d99d933f0b6e1c5143f50da9b83d2", "parameters": [ { "name": "letter", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Generated congratulatory letter" } }, "security": [ { "sanctum": [] } ] } }, "/hq/menu-counts": { "get": { "tags": [ "HQ" ], "summary": "Get HQ workspace navigation badge and overview counts", "operationId": "202680e2f340b26c59522ef6721933c5", "responses": { "200": { "description": "HQ menu counts" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/queried-licences": { "get": { "tags": [ "HQ Validator Records" ], "summary": "List queried licences visible to HQ validation and final approval users", "operationId": "56b504984bd35acd0455524b68e77268", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Queried licence list" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/active-licences": { "get": { "tags": [ "HQ Validator Records" ], "summary": "List active issued licences", "operationId": "86325f0239dba459f5411110d8d3f347", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Active licence list" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/expired-licences": { "get": { "tags": [ "HQ Validator Records" ], "summary": "List expired issued licences", "operationId": "53b8385723698af41f49ae26923147aa", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Expired licence list" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/directors": { "get": { "tags": [ "HQ Validator Records" ], "summary": "Search directors linked to applicant licence records", "operationId": "7450db57ea56939b8112ed8a0d4b3c5c", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Director search results" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/application-tracker": { "get": { "tags": [ "HQ Validator Records" ], "summary": "Search applications for HQ tracking", "operationId": "e4e0dee3d98aa34d0ed99e6019b48ca9", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Application tracker results" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/certificates": { "get": { "tags": [ "HQ Validator Records" ], "summary": "List issued certificates available to validation and final approval users", "operationId": "bfa4035c82ef386dfebf190ec2566730", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Issued certificate list" } }, "security": [ { "sanctum": [] } ] } }, "/hq/validator/application-tracker/{application}/activity": { "get": { "tags": [ "HQ Validator Records" ], "summary": "Show activity trail for a tracked application", "operationId": "9bd29acc9d63864927e455174723770e", "parameters": [ { "name": "application", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Application activity trail" }, "404": { "description": "Application not found" } }, "security": [ { "sanctum": [] } ] } } }, "components": { "securitySchemes": { "sanctum": { "type": "http", "bearerFormat": "Token", "scheme": "bearer" } } }, "tags": [ { "name": "Admin Configuration", "description": "Admin Configuration" }, { "name": "Admin", "description": "Admin" }, { "name": "Admin Users", "description": "Admin Users" }, { "name": "Applicant", "description": "Applicant" }, { "name": "Auth", "description": "Auth" }, { "name": "Bodogwu", "description": "Bodogwu" }, { "name": "Certificates", "description": "Certificates" }, { "name": "Command", "description": "Command" }, { "name": "System", "description": "System" }, { "name": "HQ", "description": "HQ" }, { "name": "HQ Validator Records", "description": "HQ Validator Records" } ] }