Category: API documentation for devs

The FIRS (Federal Inland Revenue Service, Nigeria) REST API allows you to send data to the FIRS central server. Since the API is based on REST principles, it’s very easy to write and test applications. You can use pretty much any HTTP client in any programming language to interact with the API. Our examples use […]

All URLs referenced in the documentation have the following base: Development / For testing https://api-dev.i-fis.com Production https://atrs-api.firs.gov.ng The FIRS REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

HTTP requests to the REST API are protected with OAuth 2.0 (OAuth 2.0 Framework with Bearer Token Usage). Development / For testing Send POST request to: https://api-dev.i-fis.com/oauth2/token Production Send POST request to: https://atrs-api.firs.gov.ng/oauth2/token Please register at https://atrs.firs.gov.ng/getting-started/ to get credentials for the api. Request example in Chrome ARC: [tabs][tab title=”curl”]Request: $ curl -X POST -d "client_id=testclient&client_secret=testpass&grant_type=password&username=admin&password=admin123" https://api-dev.i-fis.com/oauth2/token Response: {"access_token":"7856444b9e5cc5a9d57f75c989ff1b0140ed1340", […]

Use this HTTP request for sending receipt/bill data. Development / For testing Send POST request to: https://api-dev.i-fis.com/v1/bills/report     Production Send POST request to: https://atrs-api.firs.gov.ng/v1/bills/report   Attributes (Request)   ATTRIBUTE NAME FORMAT TYPE ENUM MAXLENGTH DESCRIPTION EXAMPLE “vat_number” “string” “string”   50   “1234567890” “business_place” “string” “string”   50   “AABBCC” “business_device” “string” “string”   […]

For signing the data use the MD5 algorithm. API uses two hash codes: SID – Securty Identifier UID – Unique Identifier (payment code retured by the API) POS software generates the SID and API generates the UID. SID client_secret – variable from authentication vat_number – Unique ID of the company business_place – Short code of business place (given after registration) business_device – serial number […]

The Swagger/OpenAPI Specification* : https://api-dev.i-fis.com/doc * The OpenAPI Specification, originally known as the Swagger Specification, is a specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful Web services.[1] A variety of tools can generate code, documentation and test cases given an interface file. Development of the OpenAPI Specification (OAS) is overseen by […]

DOWNLOAD VERSION 1.2