{ "info": { "_postman_id": "softdata-api-current-routes", "name": "SoftData API - Current Routes", "description": "Postman collection synchronized from docs/openapi.yaml. docs/openapi.yaml is the canonical API contract; the browser documentation at /docs and machine-readable artifacts at /openapi.yaml and /postman.json derive from it.\n\nSetup:\n1. Set baseUrl to the hosted API URL or a local server.\n2. Send the authentication requests first only if you need protected account routes.\n3. Copy the returned access token into accessToken for authenticated account routes.\n4. API keys are optional for public routes; set apiKey only when you want to add X-API-Key manually.\n\nAll requests are GET unless the endpoint explicitly requires POST, PATCH, or DELETE. Never store production credentials, API keys, tokens or cookies in this collection.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://softdata-api.vercel.app", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" }, { "key": "datasetId", "value": "world-states", "type": "string" }, { "key": "stateId", "value": "lagos", "type": "string" }, { "key": "lgaId", "value": "ikeja", "type": "string" }, { "key": "institutionId", "value": "example-institution", "type": "string" }, { "key": "schoolId", "value": "example-school", "type": "string" }, { "key": "healthFacilityId", "value": "222-cliford-medical-center-abia-abia-aba-north-cea7a6ea-db7e-4845-8057-5caf45dc26c1", "type": "string" }, { "key": "healthFacilityPage", "value": "1", "type": "string" }, { "key": "healthFacilityPageSize", "value": "50", "type": "string" }, { "key": "healthFacilityStateId", "value": "lagos", "type": "string" }, { "key": "healthFacilityLgaId", "value": "lagos-ikeja", "type": "string" }, { "key": "healthFacilityType", "value": "clinic", "type": "string" }, { "key": "healthFacilityLevel", "value": "primary", "type": "string" }, { "key": "healthFacilityOwnership", "value": "private", "type": "string" }, { "key": "healthFacilitySearch", "value": "", "type": "string" }, { "key": "countryId", "value": "nigeria", "type": "string" }, { "key": "keyId", "value": "example-key-id", "type": "string" }, { "key": "refreshToken", "value": "", "type": "string" }, { "key": "zoneId", "value": "south-west", "type": "string" }, { "key": "languageId", "value": "english", "type": "string" }, { "key": "timeZoneId", "value": "africa-lagos", "type": "string" }, { "key": "category", "value": "commercial-banks", "type": "string" }, { "key": "institutionAsset", "value": "example.png", "type": "string" }, { "key": "bankAsset", "value": "access-bank.png", "type": "string" }, { "key": "dataset_id", "value": "world-states", "type": "string" }, { "key": "state_id", "value": "lagos", "type": "string" }, { "key": "lga_id", "value": "lagos-ikeja", "type": "string" }, { "key": "zone_id", "value": "south-west", "type": "string" }, { "key": "country_id", "value": "ng", "type": "string" }, { "key": "language_id", "value": "en", "type": "string" }, { "key": "time_zone_id", "value": "Africa/Lagos", "type": "string" }, { "key": "university_id", "value": "university-of-lagos", "type": "string" }, { "key": "college_id", "value": "adeniran-ogunsanya-college-of-education", "type": "string" }, { "key": "institution_id", "value": "example-institution", "type": "string" }, { "key": "school_id", "value": "example-school", "type": "string" }, { "key": "provider_id", "value": "example-provider", "type": "string" }, { "key": "operator_id", "value": "example-operator", "type": "string" }, { "key": "bank_id", "value": "access-bank", "type": "string" }, { "key": "company_id", "value": "example-company", "type": "string" }, { "key": "key_id", "value": "example-key", "type": "string" }, { "key": "institution_asset", "value": "access-bank.png", "type": "string" }, { "key": "bank_asset", "value": "access-bank.png", "type": "string" }, { "key": "facility_id", "value": "222-cliford-medical-center-abia-abia-aba-north-cea7a6ea-db7e-4845-8057-5caf45dc26c1", "type": "string" }, { "key": "accreditation_id", "value": "university-of-uyo-teaching-hospital-polymerase-chain-reaction-mega-laboratory-akwa-ibom-olusugun-obasanjo-way-ml0018", "type": "string" }, { "key": "organisation_id", "value": "a-and-m-healthcare-trust-limited-102", "type": "string" }, { "key": "agency_id", "value": "abia-state-health-insurance-agency-abshia", "type": "string" }, { "key": "nhia_provider_id", "value": "ab-0001-p", "type": "string" }, { "key": "nhiaProviderCode", "value": "AB/0001/P", "type": "string" }, { "key": "medicalLabAccreditationStatus", "value": "accredited", "type": "string" }, { "key": "medicalLabStateId", "value": "lagos", "type": "string" }, { "key": "medicalLabSearch", "value": "laboratory", "type": "string" }, { "key": "hmoStatus", "value": "accredited", "type": "string" }, { "key": "hmoId", "value": "102", "type": "string" }, { "key": "hmoSearch", "value": "health", "type": "string" }, { "key": "sshiaStateId", "value": "lagos", "type": "string" }, { "key": "sshiaSearch", "value": "health", "type": "string" }, { "key": "nhiaProviderFacilityType", "value": "primary", "type": "string" }, { "key": "nhiaProviderListingStatus", "value": "active_accredited", "type": "string" }, { "key": "nhiaProviderSearch", "value": "clinic", "type": "string" }, { "key": "page", "value": "1", "type": "string" }, { "key": "page_size", "value": "50", "type": "string" }, { "key": "contact_id", "value": "federal-fire-service-fire-112-national", "type": "string" }, { "key": "emergencyServiceType", "value": "fire", "type": "string" }, { "key": "emergencyContactType", "value": "short_code", "type": "string" }, { "key": "emergencyCoverageType", "value": "national", "type": "string" }, { "key": "emergencyContactValue", "value": "112", "type": "string" }, { "key": "emergencySearch", "value": "fire", "type": "string" }, { "key": "office_id", "value": "nema-lagos-zonal-territorial-operation-office", "type": "string" }, { "key": "nemaOfficeStateId", "value": "lagos", "type": "string" }, { "key": "nemaOfficeType", "value": "zonal_territorial_operation_office", "type": "string" }, { "key": "nemaOfficeSearch", "value": "Lagos", "type": "string" } ], "item": [ { "name": "Documentation", "description": "Browser and machine-readable API documentation. docs/openapi.yaml is canonical.", "item": [ { "name": "API landing page", "request": { "method": "GET", "description": "Browser landing page with links to API documentation, OpenAPI, Postman and GitHub.", "url": { "raw": "{{baseUrl}}/", "host": [ "{{baseUrl}}" ], "path": [] } }, "response": [] }, { "name": "Interactive API documentation", "request": { "method": "GET", "description": "Browser-accessible Scalar documentation loaded from /openapi.yaml. No API key is required to browse.", "url": { "raw": "{{baseUrl}}/docs", "host": [ "{{baseUrl}}" ], "path": [ "docs" ] } }, "response": [] }, { "name": "Download OpenAPI specification", "request": { "method": "GET", "description": "Download the canonical docs/openapi.yaml contract.", "url": { "raw": "{{baseUrl}}/openapi.yaml", "host": [ "{{baseUrl}}" ], "path": [ "openapi.yaml" ] } }, "response": [] }, { "name": "Download Postman collection", "request": { "method": "GET", "description": "Download the Postman collection synchronized from docs/openapi.yaml.", "url": { "raw": "{{baseUrl}}/postman.json", "host": [ "{{baseUrl}}" ], "path": [ "postman.json" ] } }, "response": [] } ] }, { "name": "Health & Discovery", "description": "Health and API discovery endpoints. These are public and do not require authentication.", "item": [ { "name": "Health check", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Health check\n\n\nMethod: GET\nPath: /health\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/health", "host": [ "{{baseUrl}}" ], "path": [ "health" ], "query": [] } }, "response": [] }, { "name": "API discovery", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "API discovery\n\n\nMethod: GET\nPath: /v1\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1", "host": [ "{{baseUrl}}" ], "path": [ "v1" ], "query": [] } }, "response": [] } ] }, { "name": "Datasets", "description": "Dataset catalog and download endpoints. Dataset access is public; an optional X-API-Key may be supplied for higher limits and usage analytics.", "item": [ { "name": "List datasets", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List datasets\n\n\nMethod: GET\nPath: /v1/datasets\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/datasets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets" ], "query": [] } }, "response": [] }, { "name": "Get dataset details", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get dataset details\n\n\nMethod: GET\nPath: /v1/datasets/{dataset_id}\n\nPath variables: dataset_id={{datasetId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404", "url": { "raw": "{{baseUrl}}/v1/datasets/{{dataset_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets", "{{dataset_id}}" ], "query": [] } }, "response": [] }, { "name": "List dataset versions", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List dataset versions\n\n\nMethod: GET\nPath: /v1/datasets/{dataset_id}/versions\n\nPath variables: dataset_id={{datasetId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/datasets/{{dataset_id}}/versions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets", "{{dataset_id}}", "versions" ], "query": [] } }, "response": [] }, { "name": "List dataset sources", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List dataset sources\n\n\nMethod: GET\nPath: /v1/datasets/{dataset_id}/sources\n\nPath variables: dataset_id={{datasetId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/datasets/{{dataset_id}}/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets", "{{dataset_id}}", "sources" ], "query": [] } }, "response": [] }, { "name": "Download a dataset", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Download a dataset\n\n\nMethod: GET\nPath: /v1/datasets/{dataset_id}/download\n\nPath variables: dataset_id={{datasetId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/datasets/{{dataset_id}}/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datasets", "{{dataset_id}}", "download" ], "query": [] } }, "response": [] } ] }, { "name": "Geography", "description": "Public geography reference data, including states, LGAs, countries, languages, time zones, and profiles.", "item": [ { "name": "List states", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List states\n\n\nMethod: GET\nPath: /v1/geography/states\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/geography/states", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "states" ], "query": [] } }, "response": [] }, { "name": "Get a state", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a state\n\n\nMethod: GET\nPath: /v1/geography/states/{state_id}\n\nPath variables: state_id={{stateId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/states/{{state_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "states", "{{state_id}}" ], "query": [] } }, "response": [] }, { "name": "List geopolitical zones", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List geopolitical zones\n\n\nMethod: GET\nPath: /v1/geography/geopolitical-zones\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/geography/geopolitical-zones", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "geopolitical-zones" ], "query": [] } }, "response": [] }, { "name": "Get a geopolitical zone", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a geopolitical zone\n\n\nMethod: GET\nPath: /v1/geography/geopolitical-zones/{zone_id}\n\nPath variables: zone_id=south-west\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/geopolitical-zones/{{zone_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "geopolitical-zones", "{{zone_id}}" ], "query": [] } }, "response": [] }, { "name": "List local government units and FCT Area Councils", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List local government units and FCT Area Councils\n\n\nMethod: GET\nPath: /v1/geography/lgas\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/lgas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "lgas" ], "query": [] } }, "response": [] }, { "name": "Get a local government unit or FCT Area Council", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a local government unit or FCT Area Council\n\n\nMethod: GET\nPath: /v1/geography/lgas/{lga_id}\n\nPath variables: lga_id={{lgaId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/lgas/{{lga_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "lgas", "{{lga_id}}" ], "query": [] } }, "response": [] }, { "name": "List CLDR-derived world languages", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the 633 current English CLDR base-language records. This v1 endpoint has no pagination or search and is publicly accessible.\n\n\nMethod: GET\nPath: /v1/geography/languages\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/geography/languages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "languages" ], "query": [] } }, "response": [] }, { "name": "Get a CLDR-derived world language", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a CLDR-derived world language\n\n\nMethod: GET\nPath: /v1/geography/languages/{language_id}\n\nPath variables: language_id=english\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/languages/{{language_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "languages", "{{language_id}}" ], "query": [] } }, "response": [] }, { "name": "List CLDR-derived country-language relationships", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns all 1,289 relationships when filters are omitted. Filters use AND semantics, are optional, and no pagination is available in v1. The used status means CLDR supplied a relationship without officialStatus and does not independently claim legal recognition or official status.\n\n\nMethod: GET\nPath: /v1/geography/country-languages\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/country-languages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "country-languages" ], "query": [] } }, "response": [] }, { "name": "List time zones", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the current canonical IANA time-zone manifest from tzdb 2026c, limited to zone1970.tab entries. Aliases are excluded from v1. Asia/Taipei has an empty country_area_ids array because TW has no approved SoftData M49 ID, while bv and hm are valid filters that return empty lists. The list is public and returns deterministic ordering with no pagination.\n\n\nMethod: GET\nPath: /v1/geography/time-zones\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/time-zones", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "time-zones" ], "query": [] } }, "response": [] }, { "name": "Get a time zone", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a canonical IANA time-zone identifier using an exact decoded path value. The detail route accepts percent-encoded slashes at the HTTP layer, but the public identifier remains the canonical IANA name. Aliases are excluded from v1.\n\n\nMethod: GET\nPath: /v1/geography/time-zones/{time_zone_id}\n\nPath variables: time_zone_id=africa-lagos\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/time-zones/{{time_zone_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "time-zones", "{{time_zone_id}}" ], "query": [] } }, "response": [] }, { "name": "List countries and areas", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the current UN M49 countries or areas snapshot. Region and subregion filters are optional and may be combined. Statistical designations are used for reference only and do not imply political recognition or legal status.\n\n\nMethod: GET\nPath: /v1/geography/countries\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/countries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "countries" ], "query": [] } }, "response": [] }, { "name": "Get a country or area", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a verified country-or-area record from the current UN M49 snapshot. Statistical designations are used for reference only and do not imply political recognition or legal status.\n\n\nMethod: GET\nPath: /v1/geography/countries/{country_id}\n\nPath variables: country_id={{countryId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/countries/{{country_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "countries", "{{country_id}}" ], "query": [] } }, "response": [] }, { "name": "Get a country profile", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a derived profile for a current UN M49 country or area, combining the country-or-area record with approved currency, time-zone, and CLDR-derived country-language relationships. The language_ids array references world-languages.id and includes every relationship status; presence does not mean every listed language is nationally official. Use /v1/geography/country-languages for status details. Statistical designations are used for reference only and do not imply political recognition or legal status.\n\n\nMethod: GET\nPath: /v1/geography/countries/{country_id}/profile\n\nPath variables: country_id={{countryId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/geography/countries/{{country_id}}/profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "geography", "countries", "{{country_id}}", "profile" ], "query": [] } }, "response": [] } ] }, { "name": "Assets", "description": "Public flag and financial-institution asset endpoints. Asset identifiers must match supported files.", "item": [ { "name": "Get a country or area flag SVG", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a country or area flag SVG\n\n\nMethod: GET\nPath: /v1/assets/flags/{country_id}.svg\n\nPath variables: country_id={{countryId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/assets/flags/{{country_id}}.svg", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", "flags", "{{country_id}}.svg" ] } }, "response": [] }, { "name": "Get an embedded regulated-finance institution logo", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns an approved embedded PNG logo for a regulated Nigerian financial institution. Permission-pending records do not expose an asset.\n\n\nMethod: GET\nPath: /v1/assets/financial-institutions/ng/{category}/{institution_asset}\n\nPath variables: category=commercial-banks, institution_asset=example.png\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/assets/financial-institutions/ng/{{category}}/{{institution_asset}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", "financial-institutions", "ng", "{{category}}", "{{institution_asset}}" ], "query": [] } }, "response": [] }, { "name": "Get commercial bank asset", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a public commercial-bank asset from the embedded asset catalogue.\\n\\nMethod: GET\\nPath: /v1/assets/banks/ng/{bank_asset}\\nPath variable: bank_asset={{bank_asset}}\\nAuthentication: public endpoint.", "url": { "raw": "{{baseUrl}}/v1/assets/banks/ng/{{bank_asset}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", "banks", "ng", "{{bank_asset}}" ], "variable": [ { "key": "bank_asset", "value": "access-bank.png" } ] } }, "response": [] } ] }, { "name": "Education", "description": "Public Nigerian education snapshots. Institution lists are complete snapshot responses; primary and secondary schools are always paginated with a default page size of 50 and a maximum of 100. Nursing is an NMCN December 2025 snapshot, Technical Colleges are a verified NBTE row-level snapshot, and schools are a UBEC 2022 observed snapshot.", "item": [ { "name": "List universities", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the verified current NUC university register snapshot. Ownership and state filters are optional and may be combined.\n\n\nMethod: GET\nPath: /v1/education/universities\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/education/universities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "universities" ], "query": [] } }, "response": [] }, { "name": "Get a university", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a verified university record from the current NUC register snapshot.\n\n\nMethod: GET\nPath: /v1/education/universities/{university_id}\n\nPath variables: university_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/education/universities/{{university_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "universities", "{{university_id}}" ], "query": [] } }, "response": [] }, { "name": "List colleges of education", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the verified current NCCE colleges-of-education snapshot. Ownership and state filters are optional and may be combined.\n\n\nMethod: GET\nPath: /v1/education/colleges-of-education\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-education", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-education" ], "query": [] } }, "response": [] }, { "name": "Get a college of education", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a verified college of education record from the current NCCE register snapshot.\n\n\nMethod: GET\nPath: /v1/education/colleges-of-education/{college_id}\n\nPath variables: college_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-education/{{college_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-education", "{{college_id}}" ], "query": [] } }, "response": [] }, { "name": "List polytechnics", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 168 verified NBTE polytechnic records.\n\n\nMethod: GET\nPath: /v1/education/polytechnics\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/polytechnics", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "polytechnics" ], "query": [] } }, "response": [] }, { "name": "Get a polytechnic", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a polytechnic\n\n\nMethod: GET\nPath: /v1/education/polytechnics/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/polytechnics/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "polytechnics", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List monotechnics", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 86 verified NBTE monotechnic records.\n\n\nMethod: GET\nPath: /v1/education/monotechnics\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/monotechnics", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "monotechnics" ], "query": [] } }, "response": [] }, { "name": "Get a monotechnic", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a monotechnic\n\n\nMethod: GET\nPath: /v1/education/monotechnics/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/monotechnics/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "monotechnics", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List colleges of agriculture", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 31 verified NBTE colleges of agriculture records.\n\n\nMethod: GET\nPath: /v1/education/colleges-of-agriculture\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-agriculture", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-agriculture" ], "query": [] } }, "response": [] }, { "name": "Get a college of agriculture", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a college of agriculture\n\n\nMethod: GET\nPath: /v1/education/colleges-of-agriculture/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-agriculture/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-agriculture", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List colleges of health sciences and technology", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 98 verified NBTE colleges of health sciences and technology records.\n\n\nMethod: GET\nPath: /v1/education/colleges-of-health-sciences-and-technology\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-health-sciences-and-technology", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-health-sciences-and-technology" ], "query": [] } }, "response": [] }, { "name": "Get a college of health sciences and technology", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a college of health sciences and technology\n\n\nMethod: GET\nPath: /v1/education/colleges-of-health-sciences-and-technology/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-health-sciences-and-technology/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-health-sciences-and-technology", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List colleges of nursing and midwifery", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 152 public records from the NMCN December 2025 approved-schools snapshot. This is a snapshot, not a continuously current live register.\n\n\nMethod: GET\nPath: /v1/education/colleges-of-nursing-and-midwifery\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-nursing-and-midwifery", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-nursing-and-midwifery" ], "query": [] } }, "response": [] }, { "name": "Get a college of nursing and midwifery", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a college of nursing and midwifery\n\n\nMethod: GET\nPath: /v1/education/colleges-of-nursing-and-midwifery/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/colleges-of-nursing-and-midwifery/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "colleges-of-nursing-and-midwifery", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List vocational enterprise institutions", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 25 verified Digital NBTE vocational enterprise institution records.\n\n\nMethod: GET\nPath: /v1/education/vocational-enterprise-institutions\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/vocational-enterprise-institutions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "vocational-enterprise-institutions" ], "query": [] } }, "response": [] }, { "name": "Get a vocational enterprise institution", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a vocational enterprise institution\n\n\nMethod: GET\nPath: /v1/education/vocational-enterprise-institutions/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/vocational-enterprise-institutions/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "vocational-enterprise-institutions", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List technical colleges", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns 115 verified row-level institutions from the NBTE Technical Colleges directory snapshot. NBTE separately reports a sector total of 153; unidentified institutions are not fabricated into this API dataset, and wrong-category or unresolved directory entries were excluded through reconciliation.\n\n\nMethod: GET\nPath: /v1/education/technical-colleges\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/education/technical-colleges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "technical-colleges" ], "query": [] } }, "response": [] }, { "name": "Get a technical college", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a technical college\n\n\nMethod: GET\nPath: /v1/education/technical-colleges/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/technical-colleges/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "technical-colleges", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List primary and secondary schools", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns an always-paginated UBEC 2022 observed school snapshot; it is not a current live school-licensing register.\n\n\nMethod: GET\nPath: /v1/education/primary-and-secondary-schools\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 500", "url": { "raw": "{{baseUrl}}/v1/education/primary-and-secondary-schools", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "primary-and-secondary-schools" ], "query": [] } }, "response": [] }, { "name": "Get a primary or secondary school", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a primary or secondary school\n\n\nMethod: GET\nPath: /v1/education/primary-and-secondary-schools/{school_id}\n\nPath variables: school_id={{schoolId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 400, 404, 500", "url": { "raw": "{{baseUrl}}/v1/education/primary-and-secondary-schools/{{school_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "education", "primary-and-secondary-schools", "{{school_id}}" ], "query": [] } }, "response": [] } ] }, { "name": "Healthcare", "description": "Public Nigerian healthcare datasets synchronized from docs/openapi.yaml. Results are paginated where documented; optional filters are disabled by default in this collection.", "item": [ { "name": "List health facilities", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List source-verified health facilities with bounded pagination and optional filters.", "url": { "raw": "{{baseUrl}}/v1/healthcare/health-facilities?page={{healthFacilityPage}}&page_size={{healthFacilityPageSize}}&state_id={{healthFacilityStateId}}&lga_id={{healthFacilityLgaId}}&facility_type={{healthFacilityType}}&facility_level={{healthFacilityLevel}}&ownership_type={{healthFacilityOwnership}}&search={{healthFacilitySearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "health-facilities" ], "query": [ { "key": "page", "value": "{{healthFacilityPage}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{healthFacilityPageSize}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "state_id", "value": "{{healthFacilityStateId}}", "description": "Optional lowercase state ID.", "disabled": true }, { "key": "lga_id", "value": "{{healthFacilityLgaId}}", "description": "Optional lowercase LGA ID.", "disabled": true }, { "key": "facility_type", "value": "{{healthFacilityType}}", "description": "Optional facility type enum.", "disabled": true }, { "key": "facility_level", "value": "{{healthFacilityLevel}}", "description": "Optional facility level enum.", "disabled": true }, { "key": "ownership_type", "value": "{{healthFacilityOwnership}}", "description": "Optional ownership enum.", "disabled": true }, { "key": "search", "value": "{{healthFacilitySearch}}", "description": "Optional name search, maximum 100 characters.", "disabled": true } ] } }, "response": [] }, { "name": "Get a health facility", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Retrieve one health facility by facility_id.", "url": { "raw": "{{baseUrl}}/v1/healthcare/health-facilities/{{facility_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "health-facilities", "{{facility_id}}" ] } }, "response": [] }, { "name": "List medical laboratory accreditations", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List MLSCN medical laboratory accreditation records with pagination and optional filters.", "url": { "raw": "{{baseUrl}}/v1/healthcare/medical-laboratory-accreditations?page={{page}}&page_size={{page_size}}&state_id={{medicalLabStateId}}&accreditation_status={{medicalLabAccreditationStatus}}&search={{medicalLabSearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "medical-laboratory-accreditations" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{page_size}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "state_id", "value": "{{medicalLabStateId}}", "description": "Optional lowercase state ID.", "disabled": true }, { "key": "accreditation_status", "value": "{{medicalLabAccreditationStatus}}", "description": "Optional accreditation status enum.", "disabled": true }, { "key": "search", "value": "{{medicalLabSearch}}", "description": "Optional name search.", "disabled": true } ] } }, "response": [] }, { "name": "Get a medical laboratory accreditation", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Retrieve one medical laboratory accreditation by accreditation_id.", "url": { "raw": "{{baseUrl}}/v1/healthcare/medical-laboratory-accreditations/{{accreditation_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "medical-laboratory-accreditations", "{{accreditation_id}}" ] } }, "response": [] }, { "name": "List NHIA accredited Health Maintenance Organisations", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List NHIA accredited Health Maintenance Organisations with pagination and optional filters.", "url": { "raw": "{{baseUrl}}/v1/healthcare/nhia-accredited-health-maintenance-organisations?page={{page}}&page_size={{page_size}}&accreditation_status={{hmoStatus}}&hmo_id={{hmoId}}&search={{hmoSearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "nhia-accredited-health-maintenance-organisations" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{page_size}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "accreditation_status", "value": "{{hmoStatus}}", "description": "Optional accreditation status filter.", "disabled": true }, { "key": "hmo_id", "value": "{{hmoId}}", "description": "Optional NHIA HMO ID filter.", "disabled": true }, { "key": "search", "value": "{{hmoSearch}}", "description": "Optional organisation-name search.", "disabled": true } ] } }, "response": [] }, { "name": "Get an NHIA accredited Health Maintenance Organisation", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Retrieve one NHIA accredited HMO by organisation_id.", "url": { "raw": "{{baseUrl}}/v1/healthcare/nhia-accredited-health-maintenance-organisations/{{organisation_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "nhia-accredited-health-maintenance-organisations", "{{organisation_id}}" ] } }, "response": [] }, { "name": "List NHIA-listed State Social Health Insurance Agencies", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List NHIA-listed SSHIAs with pagination and optional filters.", "url": { "raw": "{{baseUrl}}/v1/healthcare/nhia-state-social-health-insurance-agencies?page={{page}}&page_size={{page_size}}&state_id={{sshiaStateId}}&search={{sshiaSearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "nhia-state-social-health-insurance-agencies" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{page_size}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "state_id", "value": "{{sshiaStateId}}", "description": "Optional lowercase state ID.", "disabled": true }, { "key": "search", "value": "{{sshiaSearch}}", "description": "Optional organisation-name search.", "disabled": true } ] } }, "response": [] }, { "name": "Get an NHIA-listed State Social Health Insurance Agency", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Retrieve one NHIA-listed SSHIA by agency_id.", "url": { "raw": "{{baseUrl}}/v1/healthcare/nhia-state-social-health-insurance-agencies/{{agency_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "nhia-state-social-health-insurance-agencies", "{{agency_id}}" ] } }, "response": [] }, { "name": "List NHIA active-accredited healthcare providers", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "List NHIA active-accredited healthcare providers with pagination and optional filters.", "url": { "raw": "{{baseUrl}}/v1/healthcare/nhia-active-accredited-healthcare-providers?page={{page}}&page_size={{page_size}}&provider_code={{nhiaProviderCode}}&facility_type={{nhiaProviderFacilityType}}&listing_status={{nhiaProviderListingStatus}}&search={{nhiaProviderSearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "nhia-active-accredited-healthcare-providers" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{page_size}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "provider_code", "value": "{{nhiaProviderCode}}", "description": "Optional exact provider-code filter.", "disabled": true }, { "key": "facility_type", "value": "{{nhiaProviderFacilityType}}", "description": "Optional facility type filter.", "disabled": true }, { "key": "listing_status", "value": "{{nhiaProviderListingStatus}}", "description": "Optional listing status filter.", "disabled": true }, { "key": "search", "value": "{{nhiaProviderSearch}}", "description": "Optional provider-name search.", "disabled": true } ] } }, "response": [] }, { "name": "Get an NHIA active-accredited healthcare provider", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Retrieve one NHIA active-accredited healthcare provider by provider_id.", "url": { "raw": "{{baseUrl}}/v1/healthcare/nhia-active-accredited-healthcare-providers/{{provider_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthcare", "nhia-active-accredited-healthcare-providers", "{{provider_id}}" ] } }, "response": [] } ] }, { "name": "Emergency", "description": "Emergency API requests synchronized from docs/openapi.yaml. Emergency service contacts and NEMA Zonal, Territorial and Operation offices are production-wired public GET routes. Both snapshots are dated source-verified datasets, not live operational-status guarantees.", "item": [ { "name": "List emergency service contacts", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Production-wired public GET route listing official emergency service contacts with pagination and optional source-supported filters. Duplicate contact values may return multiple service contexts.", "url": { "raw": "{{baseUrl}}/v1/emergency/emergency-service-contacts?page={{page}}&page_size={{page_size}}&service_type={{emergencyServiceType}}&contact_type={{emergencyContactType}}&coverage_type={{emergencyCoverageType}}&contact_value={{emergencyContactValue}}&search={{emergencySearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "emergency", "emergency-service-contacts" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{page_size}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "service_type", "value": "{{emergencyServiceType}}", "description": "Optional service type enum.", "disabled": true }, { "key": "contact_type", "value": "{{emergencyContactType}}", "description": "Optional contact type enum.", "disabled": true }, { "key": "coverage_type", "value": "{{emergencyCoverageType}}", "description": "Optional coverage type enum.", "disabled": true }, { "key": "contact_value", "value": "{{emergencyContactValue}}", "description": "Optional exact contact string; leading zeroes and +234 forms are preserved.", "disabled": true }, { "key": "search", "value": "{{emergencySearch}}", "description": "Optional service/agency-name search.", "disabled": true } ] } }, "response": [] }, { "name": "Get an emergency service contact", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Production-wired public GET route retrieving one emergency service contact by contact_id.", "url": { "raw": "{{baseUrl}}/v1/emergency/emergency-service-contacts/{{contact_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "emergency", "emergency-service-contacts", "{{contact_id}}" ] } }, "response": [] }, { "name": "List NEMA Zonal, Territorial and Operation offices", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Production-wired public GET route for listing the 17-record NEMA Zonal, Territorial and Operation offices snapshot. This request is synchronized from docs/openapi.yaml.", "url": { "raw": "{{baseUrl}}/v1/emergency/nema-zonal-territorial-operation-offices?page={{page}}&page_size={{page_size}}&state_id={{nemaOfficeStateId}}&office_type={{nemaOfficeType}}&search={{nemaOfficeSearch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "emergency", "nema-zonal-territorial-operation-offices" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Positive page number. Default: 1." }, { "key": "page_size", "value": "{{page_size}}", "description": "Page size from 1 to 100. Default: 50." }, { "key": "state_id", "value": "{{nemaOfficeStateId}}", "description": "Optional exact canonical state/FCT ID.", "disabled": true }, { "key": "office_type", "value": "{{nemaOfficeType}}", "description": "Optional office type enum.", "disabled": true }, { "key": "search", "value": "{{nemaOfficeSearch}}", "description": "Optional office-name search.", "disabled": true } ] } }, "response": [] }, { "name": "Get a NEMA Zonal, Territorial and Operation office", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Production-wired public GET route for retrieving one NEMA office snapshot record by office_id. This request is synchronized from docs/openapi.yaml.", "url": { "raw": "{{baseUrl}}/v1/emergency/nema-zonal-territorial-operation-offices/{{office_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "emergency", "nema-zonal-territorial-operation-offices", "{{office_id}}" ] } }, "response": [] } ] }, { "name": "Finance", "description": "Public Nigerian financial institution and currency endpoints. An optional X-API-Key may be supplied for higher limits and usage analytics.", "item": [ { "name": "List payment service provider memberships", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the verified CBN payment-service-provider snapshot as provider-category memberships. API-key identification remains optional once routed.\n\n\nMethod: GET\nPath: /v1/finance/payment-service-providers\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/payment-service-providers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "payment-service-providers" ], "query": [] } }, "response": [] }, { "name": "Get a payment service provider membership", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a verified provider-category membership from the CBN snapshot. API-key identification remains optional once routed.\n\n\nMethod: GET\nPath: /v1/finance/payment-service-providers/{provider_id}\n\nPath variables: provider_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/payment-service-providers/{{provider_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "payment-service-providers", "{{provider_id}}" ], "query": [] } }, "response": [] }, { "name": "List international money transfer operators", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the verified current CBN IMTO register snapshot. API-key identification remains optional once routed.\n\n\nMethod: GET\nPath: /v1/finance/international-money-transfer-operators\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/finance/international-money-transfer-operators", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "international-money-transfer-operators" ], "query": [] } }, "response": [] }, { "name": "Get an international money transfer operator", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a verified IMTO record from the CBN snapshot. API-key identification remains optional once routed.\n\n\nMethod: GET\nPath: /v1/finance/international-money-transfer-operators/{operator_id}\n\nPath variables: operator_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/international-money-transfer-operators/{{operator_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "international-money-transfer-operators", "{{operator_id}}" ], "query": [] } }, "response": [] }, { "name": "List currencies", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the current ISO 4217 monetary currency snapshot compiled from the SIX List One XML. The optional country_area_id filter narrows the list to currencies linked to a specific UN M49 country or area.\n\n\nMethod: GET\nPath: /v1/finance/currencies\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/currencies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "currencies" ], "query": [] } }, "response": [] }, { "name": "Get a currency", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns a verified ISO 4217 monetary currency from the current SIX List One XML snapshot.\n\n\nMethod: GET\nPath: /v1/finance/currencies/{currency_id}\n\nPath variables: currency_id={{currency_id}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/currencies/{{currency_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "currencies", "{{currency_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian commercial banks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the 28-record CBN commercial-bank snapshot. CBN and NIP codes are optional verified identifiers; no pagination or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/commercial-banks\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 500", "url": { "raw": "{{baseUrl}}/v1/finance/commercial-banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "commercial-banks" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian commercial bank", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns one CBN commercial-bank record. Optional code fields are omitted when unresolved in the current snapshot.\n\n\nMethod: GET\nPath: /v1/finance/commercial-banks/{bank_id}\n\nPath variables: bank_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/commercial-banks/{{bank_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "commercial-banks", "{{bank_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian microfinance banks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the 790-record roster-only CBN/NDIC-reconciled Nigerian microfinance-bank dataset in deterministic name and ID order. No pagination, search, filters, authentication, or deferred enrichment fields are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/microfinance-banks\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/microfinance-banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "microfinance-banks" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian microfinance bank", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns one roster-only Nigerian microfinance-bank record identified by its stable lowercase public ID.\n\n\nMethod: GET\nPath: /v1/finance/microfinance-banks/{bank_id}\n\nPath variables: bank_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/microfinance-banks/{{bank_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "microfinance-banks", "{{bank_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian non-interest financial institutions", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the six-record CBN non-interest financial institution snapshot. No pagination, search, or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/non-interest-financial-institutions\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/non-interest-financial-institutions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "non-interest-financial-institutions" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian non-interest financial institution", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a Nigerian non-interest financial institution\n\n\nMethod: GET\nPath: /v1/finance/non-interest-financial-institutions/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/non-interest-financial-institutions/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "non-interest-financial-institutions", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian merchant banks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the six-record CBN merchant-bank snapshot. No pagination, search, or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/merchant-banks\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/merchant-banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "merchant-banks" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian merchant bank", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a Nigerian merchant bank\n\n\nMethod: GET\nPath: /v1/finance/merchant-banks/{bank_id}\n\nPath variables: bank_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/merchant-banks/{{bank_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "merchant-banks", "{{bank_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian payment service banks", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the five-record CBN payment service bank snapshot. No pagination, search, or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/payment-service-banks\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/payment-service-banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "payment-service-banks" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian payment service bank", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a Nigerian payment service bank\n\n\nMethod: GET\nPath: /v1/finance/payment-service-banks/{bank_id}\n\nPath variables: bank_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/payment-service-banks/{{bank_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "payment-service-banks", "{{bank_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian financial holding companies", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the seven-record CBN financial holding company snapshot. No pagination, search, or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/financial-holding-companies\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/financial-holding-companies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "financial-holding-companies" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian financial holding company", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a Nigerian financial holding company\n\n\nMethod: GET\nPath: /v1/finance/financial-holding-companies/{company_id}\n\nPath variables: company_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/financial-holding-companies/{{company_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "financial-holding-companies", "{{company_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian development finance institutions", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the eight-record CBN development finance institution snapshot. No pagination, search, or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/development-finance-institutions\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/development-finance-institutions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "development-finance-institutions" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian development finance institution", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a Nigerian development finance institution\n\n\nMethod: GET\nPath: /v1/finance/development-finance-institutions/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/development-finance-institutions/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "development-finance-institutions", "{{institution_id}}" ], "query": [] } }, "response": [] }, { "name": "List Nigerian primary mortgage institutions", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Returns the current 31-record CBN primary mortgage institution snapshot. No pagination, search, or filters are provided in v1.\n\n\nMethod: GET\nPath: /v1/finance/primary-mortgage-institutions\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 405, 500", "url": { "raw": "{{baseUrl}}/v1/finance/primary-mortgage-institutions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "primary-mortgage-institutions" ], "query": [] } }, "response": [] }, { "name": "Get a Nigerian primary mortgage institution", "request": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Get a Nigerian primary mortgage institution\n\n\nMethod: GET\nPath: /v1/finance/primary-mortgage-institutions/{institution_id}\n\nPath variables: institution_id={{institutionId}}\n\nQuery parameters: \n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200, 404, 405, 422, 500", "url": { "raw": "{{baseUrl}}/v1/finance/primary-mortgage-institutions/{{institution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "finance", "primary-mortgage-institutions", "{{institution_id}}" ], "query": [] } }, "response": [] } ] }, { "name": "Authentication", "description": "Account authentication endpoints. Register/login return access and refresh tokens; logout requires the access token.", "item": [ { "name": "Register an account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Register an account\n\n\nMethod: POST\nPath: /v1/auth/register\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 201", "url": { "raw": "{{baseUrl}}/v1/auth/register", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "register" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"username\": \"demo-user\",\n \"email\": \"you@example.com\",\n \"password\": \"replace-with-a-secure-password\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Log in", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Log in\n\n\nMethod: POST\nPath: /v1/auth/login\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "login" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"username\": \"demo-user\",\n \"password\": \"replace-with-your-password\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Refresh a session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-API-Key", "value": "{{apiKey}}", "description": "Optional. Enable this header when using an API key for higher limits and usage analytics.", "type": "text", "disabled": true } ], "description": "Refresh a session\n\n\nMethod: POST\nPath: /v1/auth/refresh\n\nAuthentication: public endpoint; API key is optional where supported.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/auth/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "refresh" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"refresh_token\": \"{{refreshToken}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Log out", "request": { "method": "POST", "header": [], "description": "Log out\n\n\nMethod: POST\nPath: /v1/auth/logout\n\nAuthentication: Bearer access token. Send the current refresh token in the JSON body. After refreshing, update accessToken and refreshToken with the newly returned tokens.\n\nExpected responses: 204", "url": { "raw": "{{baseUrl}}/v1/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "auth", "logout" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"refresh_token\": \"{{refreshToken}}\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] } ] }, { "name": "Account", "description": "Authenticated account, API-key, and usage endpoints. Set the collection accessToken variable before sending these requests.", "item": [ { "name": "Get current account", "request": { "method": "GET", "header": [], "description": "Get current account\n\n\nMethod: GET\nPath: /v1/account\n\nAuthentication: Bearer access token.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "Update current account", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "description": "Update current account\n\n\nMethod: PATCH\nPath: /v1/account\n\nAuthentication: Bearer access token.\n\nExpected responses: 200, 401, 404, 409, 422, 500", "url": { "raw": "{{baseUrl}}/v1/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"username\": \"updated-user\",\n \"email\": \"you@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete current account", "request": { "method": "DELETE", "header": [], "description": "Delete current account\n\n\nMethod: DELETE\nPath: /v1/account\n\nAuthentication: Bearer access token.\n\nExpected responses: 204", "url": { "raw": "{{baseUrl}}/v1/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "List API keys", "request": { "method": "GET", "header": [], "description": "List API keys\n\n\nMethod: GET\nPath: /v1/account/api-keys\n\nAuthentication: Bearer access token.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/account/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "api-keys" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "Create an API key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "description": "Create an API key\n\n\nMethod: POST\nPath: /v1/account/api-keys\n\nAuthentication: Bearer access token.\n\nExpected responses: 201", "url": { "raw": "{{baseUrl}}/v1/account/api-keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "api-keys" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Postman development key\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Revoke an API key", "request": { "method": "DELETE", "header": [], "description": "Revoke an API key\n\n\nMethod: DELETE\nPath: /v1/account/api-keys/{key_id}\n\nPath variables: key_id={{keyId}}\n\nQuery parameters: \n\nAuthentication: Bearer access token.\n\nExpected responses: 204", "url": { "raw": "{{baseUrl}}/v1/account/api-keys/{{key_id}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "api-keys", "{{key_id}}" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "Rotate an API key", "request": { "method": "POST", "header": [], "description": "Rotate an API key\n\n\nMethod: POST\nPath: /v1/account/api-keys/{key_id}/rotate\n\nPath variables: key_id={{keyId}}\n\nQuery parameters: \n\nAuthentication: Bearer access token.\n\nExpected responses: 200", "url": { "raw": "{{baseUrl}}/v1/account/api-keys/{{key_id}}/rotate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "api-keys", "{{key_id}}", "rotate" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "View usage summary", "request": { "method": "GET", "header": [], "description": "View usage summary\n\n\nMethod: GET\nPath: /v1/account/usage\n\nQuery parameters: \n\nAuthentication: Bearer access token.\n\nExpected responses: 200, 400, 401, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/account/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "usage" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "View aggregated daily usage history", "request": { "method": "GET", "header": [], "description": "Returns daily aggregate usage for the authenticated account. Raw api_requests rows are never exposed.\n\n\nMethod: GET\nPath: /v1/account/usage/history\n\nQuery parameters: \n\nAuthentication: Bearer access token.\n\nExpected responses: 200, 400, 401, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/account/usage/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "usage", "history" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "View endpoint usage breakdown", "request": { "method": "GET", "header": [], "description": "Returns usage grouped by stable endpoint template for the authenticated account. Raw URLs and request parameters are never exposed.\n\n\nMethod: GET\nPath: /v1/account/usage/endpoints\n\nQuery parameters: \n\nAuthentication: Bearer access token.\n\nExpected responses: 200, 400, 401, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/account/usage/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "usage", "endpoints" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] }, { "name": "View dataset-group usage breakdown", "request": { "method": "GET", "header": [], "description": "Returns usage grouped by documented dataset group for the authenticated account. Null groups and raw request rows are never exposed.\n\n\nMethod: GET\nPath: /v1/account/usage/dataset-groups\n\nQuery parameters: \n\nAuthentication: Bearer access token.\n\nExpected responses: 200, 400, 401, 404, 422, 500", "url": { "raw": "{{baseUrl}}/v1/account/usage/dataset-groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account", "usage", "dataset-groups" ], "query": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] } }, "response": [] } ] } ] }