PAN to GST Journey

This API enables the businesses to fetch GST Number from Business PAN.

Journey Input Data

{
  "pan":""
}

Journey Output Data

{
  "transaction_id": "",
  "journey_transaction_id": "",
  "journey_id": "",
  "status": "SUCCESS|FAILURE|IN_PROGRESS",
  "status_code": "Refer to the table below",
  "message": "Refer to the table below",
  "decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
  "checks": [],
  "data": {
    "keys": {
      "gst_numbers": [
        {
          "gst_numbers_list": [
            {
              "gstin": "",
              "status": ""
            }
          ]
        }
      ]
    }
  }
}

📘
This journeys does not include any pre-configured Ownership or Fraud Checks. To add these checks, please contact your Account Manager.

Status Codes

Scenario	HttpStatus	status	status_code	message
When request is successful and PAN details are available.	200	SUCCESS	success	Request successful
When PAN Number provided is not a valid PAN Number format	200	FAILURE	invalid_pan_no	PAN no is invalid
When no details found at Source for given PAN Number	200	FAILURE	document_not_found	Entity not found
Multiple records found	200	FAILURE	multiple_records_found	Multiple records found
When Input doesn't contain the pan_nofield.	400	FAILURE	invalid_input	pan_no is required
Invalid Client Credentials	401	FAILURE	invalid_credentials	Invalid Client Credentials
Any unhandled error from Equal end	500	FAILURE	internal_server_error	Something went wrong, please try again.
Too many requests	429	No object will be sent, throttling happens at the gateway level.
Service Unavailable	503

📘
Journey ID will be shared as part of Onboarding

Key Descriptions

Key	Description
transaction_id	Unique identifier for the transaction.
journey_transaction_id	Unique identifier for the journey transaction.
journey_id	Unique identifier for the journey.
status	Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS.
status_code	Code representing the specific status of the transaction. Refer to the documentation for possible values.
message	Detailed message about the transaction status. Refer to the documentation for specific messages.
decision	Final decision based on all checks. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW.
checks	List of checks performed during the transaction.
pan_no	10 digit business PAN number
gstin	GSTIN number linked with the given business PAN
status	Status of the GSTIN number
decision (specific key)	Decision for this specific key based on the checks performed. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW.
checks (specific key)	List of checks performed on this specific key.