IRIS Credixo API v1.4 09thjan2018

IRIS
BUSINESS
API INTEGRATION
GUIDE
IRIS Credixo for Credit Appraisal and Monitoring
Version 1.4
09th Jan 2018
Important Notice:
• This document has been prepared by IRIS Business Services Limited
• The information in this document is confidential to the person to whom it is
addressed and should not be disclosed to any other person. It may not be
reproduced in whole, or in part, nor may any of the information contained
therein be disclosed without the prior consent of the directors of IRIS
Business Services Limited (the Company). A recipient may not solicit, directly
or indirectly (whether through an agent or otherwise) the participation of
another institution or person without the prior approval of the directors of
the Company.
• The contents of this document have not been independently verified and they
do not purport to be comprehensive, or to contain all the information that a
prospective client or partner may need. No representation, warranty or
undertaking, expressed or implied is or will be made or given and no
responsibility or liability is or will be accepted by the Company or by any of its
directors, employees or advisors in relation to the accuracy or completeness
of this document or any other written or oral information made available in
connection with the Company.
• Any form of reproduction, dissemination, copying, disclosure, modification,
distribution and or publication of this material is strictly prohibited.

© IRIS Business Services 1

Changes in API
• Added “expirytime” (Authentication token expiry time in seconds) in response of login

api.
• V1.1 of Generate Pre-canned orders supports multiple GSTINs in a single order.

Table of Contents
Changes in API .............................................................................................................................................. 2
1 Introduction ......................................................................................................................................... 4
2 Account Setup ...................................................................................................................................... 4
3 Overview of APIs .................................................................................................................................. 4
3.1 API List ......................................................................................................................................... 4
3.2 IRIS Credixo and Third Party API Interaction ............................................................................... 5
3.3 Base API URL ............................................................................................................................... 7
4 API Description ..................................................................................................................................... 8
4.1 Authentication ............................................................................................................................ 8
4.2 Get GSTIN Details ........................................................................................................................ 9
4.3 Tax Payer (KYC) Details ............................................................................................................. 10
4.4 Get Filing Period Details ............................................................................................................ 13
4.5 Create ORDER ........................................................................................................................... 14
4.6 Generate Pre-canned ORDER .................................................................................................... 16
4.7 Generate OTP ............................................................................................................................ 17
4.8 Validate OTP ............................................................................................................................. 18
4.9 Confirm Order ........................................................................................................................... 19
4.10 Get Order Result ....................................................................................................................... 20
4.11 Get Widget Order Result ........................................................................................................... 22
4.12 Get Order Status ....................................................................................................................... 23
4.13 Get Order Details ...................................................................................................................... 24
5 API SCHEMAS ...................................................................................................................................... 26
6 Annexures .......................................................................................................................................... 29
6.1 Annexure 1 : Taxpayer Types and Returns Applicable .............................................................. 29
6.2 Annexure 2 : Taxpayer Details (KYC) ......................................................................................... 30
6.2.1 Basic Information .................................................................................................................. 30
6.2.2 Principal and Additional Place of Business ........................................................................... 30
6.2.3 Return filing status ............................................................................................................... 31
6.3 Annexure 3 : GST Returns and Sections .................................................................................... 31
6.3.1 Sections of GSTR 1 – Return for outward supplies ............................................................... 31
6.3.2 Sections of GSTR 2A – Auto-drafted purchase invoices ........................................................ 32

6.3.3 Sections of GSTR 3B – Monthly Summary Return ................................................................ 32

6.4 Annexure 4 : Order Status ........................................................................................................ 32
6.5 Annexure 5 : Enabling API Access for GSTIN ............................................................................. 34
1 Introduction
IRIS Credixo is a platform to make available data and insights for speedy and efficient digital
lending. Using the IRIS Credixo APIs, lenders can get information about the borrowers from the
data sources such as GST and MCA.

The APIs enable lenders to define workflow using their own interfaces and the handshake
between IRIS Credixo and lender’s systems can be in the background

In IRIS Credixo, the any request information is referred as Order. There will be several types of
Orders. The Order Type covered in this document is GST Data.
2 Account Setup
IRIS Team will set-up the account for the lender and create the first Admin user. The Admin
user will need to complete the sign-up process. The Admin user can invite other users to access
the account.

User sign-up and management will be done through the web interface of IRIS Credixo.

Environment URL
Stage https://stage.credixo.irisinfo.com
Production https://credixo.irisinfo.com

User manual is available here.

The orders are linked to the lender account and all the users having access to the account can
view, download, and place orders for the lender account.
3 Overview of APIs
3.1 API List
Category Endpoint Type Description

Authentication Login POST Initiate a session between the lender
account and IRIS Credixo.


A session is valid for 24 hours.

Non-consent Get GSTIN GET Get GSTINs available for a PAN or a name
/Public APIs
Non-consent Taxpayer (KYC) GET Get Tax payer details and returns filed
/Public APIs using GSTIN number
Non-consent Get Filing Periods GET To get a list of the returns filed by any
/Public APIs GSTIN.
Order cycle Create / Place POST Place the order by providing the inputs
Order as required for the type of order
Order cycle Generate OTP POST To generate an OTP for activating a
GSTIN in the order
Order cycle Validate OTP POST To validate OTP sent by GST system. Only
after successful submission of OTP the
session with GST gets started for the
GSTIN
Order cycle Confirm Order PUT To confirm the order placed by the user
once all the GSTINs have been activated
Order cycle Get Order Result GET To get data and results of the order
Order cycle Get Order Details GET To know the Order details based on
Order id.
Order cycle Get Order Status GET To know the status of the order
3.2 IRIS Credixo and Third Party API Interaction

Interaction with Non-consent – GST APIs


Getting GST data with Borrower consent

3.3 Base API URL
Environment URL
Stage https://stage.credixo.irisinfo.com/credixo/[version]/[endpoint]
Production https://credixo.irisinfo.com/credixo/[version]/[endpoint]

4 API Description
4.1 Authentication
This API that allows user to login into IRIS Credixo.

Request Parameters
The input parameters that will be supported in the API request are as below
• Username (email, mandatory): This is the email id of the user trying to authenticate with IRIS
Credixo.
• Password (password, mandatory): This is the password of the user trying to authenticate with
IRIS Credixo.
Response Parameters
The API will respond with an enveloped response. The response information is as below:
• X-Auth-Token (token): An authentication token that needs to be passed in all subsequent
requests
• Expiry Time (in seconds): Token expiry time post successful generation of token.
Sample Request and Response
URL https://stage.credixo.irisinfo.com/credixo/v1/login
Method POST
Headers Content-Type:application/json
Body {
"username": "abc.def@business.com",
"password": "Abc@1234"
}
Response {
(SUCCESS) "status": "success",
"next": "/credixo/",
"token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo
0LCJ1c2VybmFtZSI6IU0NTkwNTI0MCwiZW1haWwiOiJuaXRpbi5ja
GFuZHJhQGlyaXNidXNpbmVzcy5jb20ifQ.0HOV-
FJvK2FHqT9w7YC0ZIWp4jlj6mUY-JDOJUVQy2E",
"expirytime": "6600"
}
Response {
(FAILURE) "status": "failure",
"message": "Invalid email or password. Try
again."
}

4.2 Get GSTIN Details

This API will allow user to get GSTINs for the provided PAN number.

Request Parameters
The input parameters that will be supported in the API request are as below:
• X-Auth-Token: An authentication token needs to be passed in all requests
• PAN(mandatory): User needs to input PAN Number to get GSTIN Details of that PAN.
Response Parameters
The API will respond with an enveloped response with a collection of results object. The
response information is as below:
• Status: Success/Failure for the object.
• Message: Success/Failure message for the object
• GSTIN List: List of GSTINs for that PAN with the following information.
§ GSTIN : GSTIN number corresponding to that PAN
§ Name : name of that GSTIN
§ Taxpayer Type : Shows the type of the taxpayer of that GSTIN

Refer Annexure 1 : Taxpayer Types and Returns Applicable for the detailed information.
URL https://stage.credixo.irisinfo.com/credixo/v1/gstns?pan= ABCDE1111A

Filter Parameters (to be appended in the URL):
Pan:Pan Number
Method GET
Authorization:Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWI
iOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2Vi
IiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwJ0ZW5hbnQ
iOiJkZXYifQ.-
NdGYNyUV7j_tLpBdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC
6wndLhFNlIgC8jkjuBO7KtJKfd3g
Response {
-SUCCESS "status": "SUCCESS",
"message": "Gstins has been fetched",
"gstinList": [
{
"taxpayerType": "Regular",
"gstin": "02ABCDE1111A1ZV",
"name": "ABCD PVT LTD."
},
{
"taxpayerType": "Regular",
"gstin": "02ABCDE1111A2ZU",

"name": " ABCD PVT LTD."

},
{
"taxpayerType": "SEZ",
"gstin": "02ABCDE1111A1ZT",
"name": "M/S ABCD PVT LTD."
},
{
"taxpayerType": "ISD",
"gstin": "24ABCDE1111A1ZP",
"name": " ABCD PVT LIMITED"
}
]
}
Response {
(FAILURE, "status": "FAILURE",
No response "message": "No gstins found",
Found) "error": []
}
Response {
(FAILURE, "detail": "Signature has expired."
Signature }
expires for
IRIS)
4.3 Tax Payer (KYC) Details

This API will allow users to get Tax payer details and the GST return filing status using GSTIN
number.
Request Parameters
• X-Auth-Token: An authentication token that needs to be passed in all subsequent requests
• GSTIN(mandatory): GSTIN for which details are needed
Response Parameters
• Message: Success/Failure message for the object.
• Data: Following taxpayer details are provided :-
§ type: Type of GSTIN.
§ Name: Name of GSTIN. (Legal Name)
§ Trade Name
§ Gstnstatus: current status of GSTIN(Active/Inactive/Cancelled).

§ regDate: registration Date of the GSTIN.

§ last_updated_date: last updated date of the GSTIN.
§ Returntype: filing list of the along with the return type of the GSTIN.
§ State: state to which the GSTIN belongs.
§ Center_jurisdiction: Zone to which the GSTIN belongs.
§ Ntr : Nature of business.
§ Address: Registered address of the GSTIN.
§ Add_address: Additional address for the GSTIN.
§ Center Code
§ State Code
§ Cancellation Date
Refer to Annexure 2 : Taxpayer Details (KYC) for detailed field description.
URL https://stage.credixo.irisinfo.com/credixo/v1/txPayerDetails?gstin=20ABCDE1111A1
Z0

Gstin: Gstin Number
Method GET
Authorization:Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdW
IiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2V
iIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwJ0ZW5hbn
QiOiJkZXYifQ.-
Body -
Response {
(SUCCESS) "status": "SUCCESS",
"message": "Gstin type fetched",
"data": {
"gstin": "27AAACI9260R1ZV",
"type": "Regular",
"name": "IRIS BUSINESS SERVICES LIMITED",
"tradename": "M/S IRIS BUSINESS SERVICES LTD.",
"gstnstatus": "Active",
"last_updated_date": "2018-04-14",
"regDate": "2017-07-01",
"returnType": {
"EFiledlist": [
{

"mof": "ONLINE",
"arn": "AA2707178232418",
"valid": "Y",
"ret_prd": "072017",
"status": "Filed",
"rtntype": "GSTR3B",
"dof": "24-08-2017"
}
]
},
"state": "THANE CITY",
"center_jurisdiction": "RANGE-III",
"constitution": "Public Limited Company",
"ntr": [
"Service Provision",
"Recipient of Goods or Services"
],
"address": {
"lt": "",
"bnm": "INTERNATIONAL INFOTECH PARK",
"lg": "",
"stcd": "Maharashtra",
"loc": "NAVI MUMBAI",
"ntr": "Service Provision, Recipient of Goods
or Services",
"bno": "T-231, TOWER-2",
"flno": "3RD FLOOR",
"st": "VASHI",
"pncd": "400703"
},
"add_address": [],
"center_cd": "VU0203",
"status_code": 1,
"fetchTime": "2018-10-12T16:43:01.364",
"cancellationDate": null,
"state_cd": "MH033"
}
}
Response {
(Failure, "status": "FAILURE",
Invalid "message": "Invalid gstin"
Gstin) }
Response {
(FAILURE) "detail": "Signature has expired."
}


4.4 Get Filing Period Details

This API will allow user to get a list of the returns filed and its period by the GSTIN. This API is
optional and can be used before creating any order so that data for valid periods and returns
can be requested. This will help to optimize the API call requests.

Request Parameters
• X-Auth-Token: An authentication token that needs to be passed in all subsequent requests.
• GSTIN(mandatory): GSTIN of the taxpayer to get filing period details.
Response Parameters
The API will respond with an enveloped response with a collection of invoice object. The
• message: Success/Failure message for the object.
• Filing List: filing period details for that GSTIN based on return type with following information:
§ Return Type: Return type with the list of filing periods for that GSTIN
URL https://stage.credixo.irisinfo.com/credixo/v1/filingStatus?gstin=20ABCDE1111A1Z2

Gstin: Gstin Number
Method GET
iOiJkZXYifQ.-
Body -
Response {
(SUCCESS "status": "SUCCESS",
) "message": "Gstins has been fetched",
"fillingList": {
"GSTR3B": [
"082018",
"072018",
"062018",
"052018",
"042018",
"032018",
"022018"

],
"GSTR1": [
"082018",
"072018",
"062018",
"052018",
"042018",
"032018",
"022018"
],
"GSTR2": [
"072017"
],
"GSTR2A": []
}
}
Response {
(Failure but "status": "FAILURE",
“Invalid "message": "Invalid Gstin"
Gstin” }
Response {
}

4.5 Create ORDER

This API will allow the user to place order for the information needed. In IRIS Credixo, there will
be several types of orders and each of these orders could need different input parameters.

For the order type GST Data, following are the API details

Request Parameters
• PAN(optional): Pan Number of the GSTINs to be submitted.
• Slug(mandatory): Slug to authenticate the user account for placing and confirming an order in
the header
• subRequest: List of gstin with the following details:-
§ Gstin(mandatory): Gstin Number to be submitted
§ taxpayerName(mandatory): Name of the GSTIN
§ Returntype(mandatory) : return type of the GSTIN
§ Fp(mandatory): Filing period of the GSTIN
§ Section (mandatory): Section type of the return
• isCsv(mandatory): If True, it will give a CSV file for download on completion of order.

Refer to Annexure 3 : GST Returns and Sections for detailed information on sections available
for commonly filed returns
Response Parameters
• Token: Order id of the generated Order.
URL https://stage.credixo.irisinfo.com /credixo/v1/order/create
Method POST
iOiJkZXYifQ.-
Slug: iris-business-services-pvt-ltd
Body {
"pan":"GSPTN1621G",
"subRequests":[
{
"gstin":"33GSPTN1621G1ZI",
"returntype":"GSTR1",
"fp":"082018",
"section":"B2B",
"taxpayerName":"Amit Corporation LTD "
}
],
"merge":false,
"isCsv":true
}
Response {
"message": "Order request submitted",
"token": "ORD2018092510203"
}
Response {
(Errors, "status": "FAILURE",
error codes "message": "Order submission failed"
}

with short
description)
Response {
}

4.6 Generate Pre-canned ORDER

This API will allow the user to place order for the information needed. In IRIS Credixo, there will
be several types of orders and each of these orders could need different input parameters.
Custom order types can be made as desired by the user.

For INSIGHTS the user can choose from any of the available 16 widgets. (See Annexure 5 for
details)
For the order type GST Data, following are the API details

Request Parameters
the header
• PAN(optional): Pan Number of the GSTINs to be submitted.
• GSTIN: GSTIN for the taxpayer for which data needs to be fetched
• Order Type: Type of order which needs to be processed
Response Parameters
• Token: Order id of the generated Order.
URL https://stage.credixo.irisinfo.com /credixo/v1.1/order/generate
Method POST
iOiJkZXYifQ.-

Body {
"pan":"GSPTN1621G",
"gstin":[”27AAAAA1234R1ZV”],
“ordertype”:”RETSUM_12M”
}
Response {
"message": "Order request submitted",
"token": "ORD2018092510203"
}
Response {
(Errors, "status": "FAILURE",
error codes "message": "Order submission failed"
with short }
description)
Response {
}
4.7 Generate OTP

This API will allow user to generate an OTP for activating a GSTIN in the order. It should be
noted that the API access for the GSTIN should be enabled. Refer Annexure 6: Enabling API
Access for GSTIN to know the process for enabling API access.

Request Parameters
• orderId(mandatory): Order id to confirm that order.
• Gstin(mandatory): GSTIN number to that particular order id.
• Username(mandatory): The username registered with GST Portal.
Response Parameters

URL https://stage.credixo.irisinfo.com /credixo/v1/generateotp
Method POST
Authorization:Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ
wcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwi
Y3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYzLCJ0Z
dTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jk
juBO7KtJKfd3g
Body {
"gstin":"33GSPTN1621G1ZI",
"username":"ABD.TN.1",
"orderId":"ORD2018092666503"
}
Response {
"message": "OTP Generated Successfully"
}
Response {
(FAILURE) "status": "FAILURE",
"message": "OTP could not be generated",
"error": "System Error"
}
Response {
}

4.8 Validate OTP

This API will allow user to validate OTP, only after which an order can be confirmed.

Request Parameters
• Gstin(mandatory): GSTIN number to that particular order id.
• Username(mandatory): The OTP generated is based on the username provided by the user.
• OTP(mandatory): OTP sent by GST portal on the mobile number registered on GST portal
Response Parameters

URL https://stage.credixo.irisinfo.com /credixo/v1/ validateotp
Method POST
Authorization:Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdW
IiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2V
iIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYz
LCJ0ZdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlI
gC8jkjuBO7KtJKfd3g
Body {
"otp": "575757",
"gstin": "33GSPTN1621G1ZI",
"username": "ABD.TN.1",
"orderId": "ORD2018092666503"
}
Response {
"message": "GSTIN Authenticated Successfully"
}
Response {
"message": "OTP could not be validated",
"error": "System Error"
}
Response {
}
4.9 Confirm Order

This API will allow user to confirm the created order once sessions for all the required GSTINs
have been activated using validate OTP process.

Request Parameters
the header

Response Parameters
URL https://stage.credixo.irisinfo.com /credixo/v1/order/confirm
Method PUT
Authorization:Bearer eyJhbGciOiJIUzUxMiJ9.ey
JzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjo
id2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcx
MzYzLCJ0ZdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLh
FNlIgC8jkjuBO7KtJKfd3g
Body {
"orderId": "ORD2018002666503"
}
Response {
"message": "Order Confirmed"
}
Response {
"message": "Could not confirm order. Try Again"
}
Response {
}

4.10 Get Order Result

This API will allow user to get results of the order that was completed by the user.

Request Parameters
• orderId(mandatory): Order id of the order whose results are needed.
the header.

Response Parameters
• Order status: Order status of the order.
• Download Url: If order status is complete, an URL to download a file if while submitting order
“isCsv” was true file will be in CSV format else if “isCsv” field was false data would be in Json
format will be provided.
URL https://stage.credixo.irisinfo.com/credixo/v1/order/results?orderId=ORD2010091916
918

Order id: Order Id
Method GET
JzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGlmNlIjoid
2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMz
YzLCJWbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8
jkjuBO7KtJKfd3g
Body -
Response {
"message": "Order status successfully fetched",
"orderstatus": "COMPLETE",
"downloadUrl": "https://spinel-
bulkdata.s3.amazonaws.com/bellatrix/downloads/ORD20180019
16918.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-
Credential=AKIAJG4AROXGEXU43MRA%2F20180926%2Fap-south-
1%2Fs3%2Faws4_request&X-Amz-Date=20180926T100909Z&X-Amz-
Expires=600&X-Amz-SignedHeaders=host&X-Amz-
Signature=89c05dceda0f6ce07364e430bd5505a237627a8a21a1b24
ce7d523e1e4e889d7"
}
Response {
"message": "Order does not belong to account"
}
Response {
}

4.11 Get Widget Order Result

This API will allow user to get results of the order that was completed by the user.

Request Parameters
the header.
Response Parameters
• Result JSON: For each widget type a separate aggregated json response
URL https://stage.credixo.irisinfo.com/credixo/v1/widget/results?orderId=ORD201009191
6918

Order id: Order Id
Method GET
YzLCJWbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8
jkjuBO7KtJKfd3g
Body -
Response {
"message": "Widget Result has been fetched",
"result": {
"orderId": "ORD2018122416129",
"sales_overview": [
{
"fp": "Oct 2018",
"value": 229

},
{
"fp": "Nov 2018",
"value": 246
},
{
"fp": "Dec 2018",
"value": 0
}
],
"sales_performance": [
{
"fp": "Oct 2018",
"value": 229,
"within": 0
},
{
"fp": "Nov 2018",
"value": 246,
"within": 0
}
]
}
}
Response {
}
Response {
}
4.12 Get Order Status

This API will allow user to get status of the order that was placed by the user.

Request Parameters
the header
Response Parameters


Refer Annexure 4 : Order Status for further details

URL https://stage.credixo.irisinfo.com/credixo/v1/order/status?orderId=ORD20180099169
18

Order id: Order Id
Method GET
YvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkj
uBO7KtJKfd3g
Body -
Response {
"message": "Order status successfully fetched",
"orderstatus": "COMPLETE"
}
Response {
}
Response {
}
4.13 Get Order Details

This API allows the user to GET the Order details based on Order id. This API can give details of
individual sub-orders and its status

Request Parameters
• X-Auth-Token: An authentication token that needs to be passed in all subsequent requests.


the header
Response Parameters
• Orderdetails: order details include following data:
§ GSTIN : GSTIN included in the order.
§ Fp: filing Period of the GSTIN in the order.
§ Returntype: return Type of the GSTIN in the order.
§ Section: Section Type of the Order.
§ Status: Status of the Order.
§ Error: Error Related to that particular Order.
URL https://stage.credixo.irisinfo.com/credixo/v1/order/details?orderId=ORD2018092526
610
Method GET
YCv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuB
O7KtJKfd3g
slug:iris-business-services-pvt-ltd
Body -
Response {
"message": "Order details successfully fetched",
"orderdetails": [
{
"gstin": "34GSPTN1621G1ZI",
"fp": "082018",
"returntype": "GSTR1",
"section": "B2B",
"status": "NEW",
"error": "None"
}
]
}

Response {
}
Response {
}

5 API SCHEMAS
API Schema
Login {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"username",
"password"
]
}
Create Order {
"$ref": "#/definitions/createOrder",
"definitions": {
"createOrder": {
"type": "object",
"additionalProperties": False,
"properties": {
"pan": {
"type": "string"
},
"subRequests": {
"type": "array",
"items": {
"$ref": "#/definitions/SubRequest"
}
},
"merge": {
"type": "boolean"
},

"client": {
"type": "string"
},
"email": {
"type": "string"
},
"panName": {
"type": "string"
},
"isCsv": {
"type": "boolean"
}
},
"required": [
"isCsv",
"merge",
"pan",
"subRequests"
],
"title": "createOrder"
},
"SubRequest": {
"type": "object",
"properties": {
"gstin": {
"type": "string"
},
"returntype": {
"type": "string"
},
"fp": {
"type": "string"
},
"section": {
"type": "string"
},
"taxpayerName": {
"type": "string"
},
"autoNum": {
"type": "integer"
}
},
"required": [
"fp",
"gstin",
"returntype",
"section",
"taxpayerName"
],

"title": "SubRequest"
}
}
}
Generate OTP {
"$ref": "#/definitions/GenerateOTP",
"definitions": {
"GenerateOTP": {
"type": "object",
"properties": {
"gstin": {
"type": "string"
},
"username": {
"type": "string"
},
"orderId": {
"type": "string"
}
},
"required": [
"gstin",
"orderId",
"username"
],
"title": "GenerateOTP"
}
}
}
Validate OTP {
"$ref": "#/definitions/ValidateOTP",
"definitions": {
"ValidateOTP": {
"type": "object",
"properties": {
"otp": {
"type": "string",
"format": "integer"
},
"gstin": {
"type": "string"
},
"username": {
"type": "string"
},
"orderId": {
"type": "string"

}
},
"required": [
"gstin",
"orderId",
"otp",
"username"
],
"title": "ValidateOTP"
}
}
}

6 Annexures

6.1 Annexure 1 : Taxpayer Types and Returns Applicable

Type of taxpayer Returns Transactions covered
Normal Taxpayer /SEZ
Taxpayer GSTR-1 Details of outward supplies of goods or services
Normal Taxpayer /SEZ Details of auto drafted supplies of purchases (mostly from
Taxpayer GSTR-2A GSTR 1 of the supplier)
Normal Taxpayer /SEZ Summarised Monthly Return containing aggregate details

Taxpayer GSTR-3B of Sales, ITC claimed and tax liability.
Normal Taxpayer /SEZ
Taxpayer GSTR - 9 Annual return
Normal Taxpayer /SEZ Details of goods/capital goods sent to job worker and
Taxpayer GST ITC-04 received back
Quarterly return for registered person opting for
Composition Dealer GSTR-4 composition levy.( Businesses having turnover upto 1.5 cr)
Auto-drafted purchase details for composition dealer.
Composition Dealer GSTR-4A (Mostly auto-drafted from GSTR-1 of supplier)
Composition Dealer GSTR - 9A Annual return
Non-resident taxable person GSTR-5 Return for Non-resident taxable person
Person suppling online Details of supplies of online information and database
information and database access or retrieval services by a person located outside
access GSTR-5A India made to non-taxable persons in India
Input service distributor (ISD) GSTR-6 Return for input service distributor
Details of inward supplies auto-drafted form (Auto-drafted
Input service distributor (ISD) GSTR-6A from GSTR-1)

TDS deductor GSTR-7 Return for Tax Deducted at Source

TDS deductor GSTR 7A Tax Deduction at Source Certificate
E-commerce operator GSTR - 8 Statement for tax collection at source
E-commerce operator GSTR - 9B Annual return
Normal taxpayer GSTR-10 Final return
Statement of inward supplies by persons having Unique
UIN - holder GSTR -11 Identification Number (UIN)
Taxpayer having turnover
above 2 cr GSTR - 9C Reconciliation Statement of GST and Annual Accounts

6.2 Annexure 2 : Taxpayer Details (KYC)

6.2.1 Basic Information

Description Field Specifications Example
GSTIN of the Tax Payer String 27ABCDE1245A1ZD
Legal Name of Business String ABC Ltd.
State Jurisdiction String Maharashtra
Centre Jurisdiction String Delhi
Date of Registration Date [DD/MM/YYYY] 01-07-2017
Constitution of Business String Company
Taxpayer type String Regular
Nature of Business Array of Strings Examples - ["Bonded Warehouse",
Activity "Factory / Manufacturing",
"Input Service Distributor (ISD)",
"Office / Sale Office" ]
GSTN status String Active
Date Of Cancellation Date [DD/MM/YYYY] NA
Last Updated Date Date [DD/MM/YYYY] 01-06-2018
State Jurisdiction Code String AP003
Centre Jurisdiction Code String AP004
Trade Name String ABC Ltd.
6.2.2 Principal and Additional Place of Business

Description Field Specifications Example
Building Name String Infotech Park
Street String Mahavir Road
Location String Vashi
Door Number String T131
State Name String Maharashtra

Floor String 3rd Floor

Latitude String 74.2179
Longitude String 27.0238
Pin Code Integer 400705
Nature of Place of business Array of Strings Wholesale Business
(Additional/Principal)

6.2.3 Return filing status
Description Field Specification Example

ARN Number generated Alphanumeric (Max length:25) AA010143556587A
after filing
Tax Period Selected by String(MMYYYY) 032018
user
Mode of Filing String((OFFLINE/ONLINE)) ONLINE
Date of Filing String(DD-MM-YYYY) 08-02-2017
Return Type String GSTR1
Status of the Return filed String(10 Character) Filed
Is Return Valid/Invalid ? 1 Character Y/N
6.3 Annexure 3 : GST Returns and Sections
6.3.1 Sections of GSTR 1 – Return for outward supplies
Section Description
B2B Invoices. Taxable outward supplies made to registered persons (including UIN-
B2B holders) including supplies made to SEZ and deemed exports
B2BA Amended B2B Invoices
CDNR Credit and Debit Note for Registered Taxpayers
CDNRA Amended Credit and Debit Note for Registered Taxpayers
CDNUR Credit and Debit Note for Unregistered Taxpayers
CDNURA Credit and Debit Note for Unregistered Taxpayers Amendment
B2C Large Invoices. Taxable outward inter-State supplies to un-registered persons where
B2CL the invoice value is more than Rs 2.5 lakh
B2CLA Amended B2C Large Invoices
B2CS B2C Small Invoices. All intra-state transactions and inter-state below 2.5 lac
B2CSA Amended B2C Small Invoices
AT Advance Tax (Tax on Advance Received)
ATA Amended Advance Tax

TXP Advance Adjusted Detail (Tax adjusted against advances)

TXPA Advance Adjusted Detail Amendment
EXP Exports
EXPA Amended Exports
Nil rated supplies Nil rated, exempted and non GST outward supplies
HSN Summary hsn_summary_details
Doc Issued Documents issued during the return period
RETSUM Section wise summary of all GSTR 1 Sections. Includes Counterparty wise summary
6.3.2 Sections of GSTR 2A – Auto-drafted purchase invoices
Section Description
B2B B2B Invoices
B2BA Amended B2B Invoices
CDN Credit and Debit Note for Registered Taxpayers
CDNA Amended Credit and Debit Note for Registered Taxpayers
ISD ITC distribution through ISD invoices
ISDA Amendments to ITC distribution
TDS credit ITC credit on account of TDS deducted
TDSA details Amendments to ITC credit for TDS
6.3.3 Sections of GSTR 3B – Monthly Summary Return

Section Description
RETSUM 3.1 Tax on outward and reverse charge inward supplies
3.2 Inter-state supplies
4. Eligible ITC
5.1 Interest and Late fee
6.1 Payment of tax
6.2 TDS/TCS Credit

6.4 Annexure 4 : Order Status
Status Description
ORDER PLACED This is the status when the order is placed by the user.
ORDER CONFIRMED This is the status when order is confirmed by the user.

IN PROGRESS This is the status when user has confirmed the order and
the system is processing the order to generate
download file.
MERGE IN PROGRESS This is the status when the system is merging the sub
orders after the order is confirmed.
COMPLETE This is the status when is order processing is complete
and is available for download.
USER CANCELLED This is the status when user cancels the order placed by
him.
SYSTEM CANCELLED This is the status which user order is cancelled by the
system.
USER ACTION REQUIRED This status is generated in case of some error during the
processing of the order.
FAILURE This status is generated in case of failure to process the
order.
6.5 Annexure 5 : Widget Types for INSIGHTS
# Widget Name Description

Outward supplies Including inter-branch transfers. While filing
Widget return entity would have done adjustment for advances and
1 Sales Overview amendments
Widget Sales Performance Adjusted Outward supplies with adjustments made for intra-PAN
2 for intra-PAN transactions invoices, debit and credit notes
Widget
3 Purchases overview Inward supplies from B2B
Widget Advances Received and Pattern of advances received and the sales effected against
4 Adjustment the adjustment
Widget
5 Top 10 Vendors Top 10 Registered B2B vendors based on transaction value
Widget
6 Top 10 Customers Top 10 Registered B2B customers based on transaction value
Widget Top 10 Registered B2B vendors based on transaction value,
7 Top 10 Vendors External other than intra-PAN
Widget Top 10 Registered B2B customers based on transaction value,
8 Top 10 Customers External other than intra-PAN
Widget Count of counterparties
9 (Sales) Unique parties with whom the borrower is transacting
Widget
10 Growth in counterparties Indication of how the business is growing
Widget Purchase Adjusted for intra-
11 PAN transactions Inward supplies from B2B adjusted for intra-PAN transactions
Widget Overview of supplies made HSN wise. Indicates which
12 HSN Summary products and services are being transacted

Widget
13 GSTIN Wise Turnover Turnover based on GSTR3B
Widget
14 Sales Breakup - I Breakup of Sales – Domestic vs Export
Widget
15 Sales Breakup - II Breakup of Sales based on Place of Supply
Widget Count of Counterparties
16 (Purchases) Unique parties with whom the borrower is transacting
6.6 Annexure 6: Enabling API Access for GSTIN
To manage your GST filings through IRIS GST- Sapphire, a one-time activity of enabling API
access is required to be undertaken for every GSTIN. Step-wise procedure to enable the API
access is listed below.

Step 1: Logging on to GSTN portal
User will have to log-on to the GSTN Portal (https://www.gst.gov.in/) using the login
credentials.

Step 2: Navigate to ‘View Profile’
Under the ‘Dashboard’ section, select ‘View Profile’

Step 3: Select ‘Manage API Access’


Step 4: Enabling API request Under the ‘Manage API Request’, select the radio button of ‘Yes’

Step 5: Specify the duration and confirm Select the duration of ’30 days’ from the dropdown
and confirm the same


IRIS Credixo API v1.4 09thjan2018

Uploaded by

Copyright:

Available Formats

IRIS Credixo API v1.4 09thjan2018

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IRIS Credixo API v1.4 09thjan2018

Uploaded by

Copyright:

Available Formats

IRIS

© IRIS Business Services 1

• Added “expirytime” (Authentication token expiry time in seconds) in response of login

© IRIS Business Services 2

© IRIS Business Services 3

6.3.3 Sections of GSTR 3B – Monthly Summary Return ................................................................ 32

3.1 API List

Category Endpoint Type Description

A session is valid for 24 hours.

3.2 IRIS Credixo and Third Party API Interaction

© IRIS Business Services 5

© IRIS Business Services 6

3.3 Base API URL

© IRIS Business Services 7

Sample Request and Response

© IRIS Business Services 8

4.2 Get GSTIN Details

Sample Request and Response

URL https://stage.credixo.irisinfo.com/credixo/v1/gstns?pan= ABCDE1111A

© IRIS Business Services 9

"name": " ABCD PVT LTD."

4.3 Tax Payer (KYC) Details

© IRIS Business Services 10

§ regDate: registration Date of the GSTIN.

Refer to Annexure 2 : Taxpayer Details (KYC) for detailed field description.

Sample Request and Response

Filter Parameters (to be appended in the URL):

© IRIS Business Services 11

© IRIS Business Services 12

4.4 Get Filing Period Details

Sample Request and Response

Filter Parameters (to be appended in the URL):

© IRIS Business Services 13

4.5 Create ORDER

© IRIS Business Services 14

Sample Request and Response

URL https://stage.credixo.irisinfo.com /credixo/v1/order/create

© IRIS Business Services 15

4.6 Generate Pre-canned ORDER

Sample Request and Response

URL https://stage.credixo.irisinfo.com /credixo/v1.1/order/generate

© IRIS Business Services 16

4.7 Generate OTP

Sample Request and Response

© IRIS Business Services 17

URL https://stage.credixo.irisinfo.com /credixo/v1/generateotp

4.8 Validate OTP

© IRIS Business Services 18

Sample Request and Response

URL https://stage.credixo.irisinfo.com /credixo/v1/ validateotp

4.9 Confirm Order

© IRIS Business Services 19

Sample Request and Response

URL https://stage.credixo.irisinfo.com /credixo/v1/order/confirm

4.10 Get Order Result

© IRIS Business Services 20

Sample Request and Response

Filter Parameters (to be appended in the URL):

© IRIS Business Services 21