Update gst apis#50
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a substantial expansion of the API documentation by integrating a new collection of Touras APIs. The changes provide detailed specifications for a wide array of verification and information retrieval services, covering critical areas such as Know Your Customer (KYC), financial transactions, corporate identity, transport, and communication. This update aims to equip developers with extensive resources for leveraging these newly added functionalities. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds extensive documentation for the new Touras KYC and Verification APIs. The new content is well-structured for the most part, but I've identified a few areas for improvement to enhance consistency and clarity for developers. My main feedback concerns an inconsistent heading structure for the PAN APIs. I've also pointed out several smaller issues, such as a missing date format specification, a confusingly named field in a sample response, and several grammatical and consistency errors in API response messages. Applying these suggestions will improve the overall quality and usability of the documentation.
Note: Security Review has been skipped due to the limited scope of the PR.
| ### 1. PAN Verification API | ||
| Verify PAN details including holder name and status. | ||
|
|
||
| #### Details | ||
| - **Method:** POST | ||
| - **URL Endpoint:** /tools/kyc/touras/pan-verification | ||
| - **Request Structure:** | ||
| - **Body Parameters:** | ||
| - initiator_id (string / required) - Your registered mobile number. | ||
| - user_code (string / required) - User code value of the retailer from whom the request is coming. | ||
| - pan_number (string / required) - The PAN number you want to verify. | ||
|
|
||
| #### Sample Response (200 OK) | ||
| ```json | ||
| { | ||
| "response_status_id": 0, | ||
| "data": { | ||
| "upstream_rrn": "pan_abc123xyz", | ||
| "pan_no": "ABCDE1234F", | ||
| "fullname": "JOHN DOE", | ||
| "category": "person", | ||
| "status": "success" | ||
| }, | ||
| "response_type_id": 0, | ||
| "status": 0 | ||
| } | ||
| ``` | ||
| ### 2. PAN Comprehensive API |
There was a problem hiding this comment.
The heading structure for the PAN APIs is inconsistent with the rest of the document. The PAN-related APIs are at heading level 3 (###), but they are not grouped under a level 2 heading (##). Additionally, the numbering (### 1. and ### 2.) conflicts with the next section, which is ## 2. Bank Account APIs. To improve clarity and consistency, I suggest grouping the PAN APIs under a ## 1. PAN APIs heading and adjusting the sub-headings accordingly.
## 1. PAN APIs
### 1.1. PAN Verification API
Verify PAN details including holder name and status.
#### Details
- **Method:** POST
- **URL Endpoint:** /tools/kyc/touras/pan-verification
- **Request Structure:**
- **Body Parameters:**
- initiator_id (string / required) - Your registered mobile number.
- user_code (string / required) - User code value of the retailer from whom the request is coming.
- pan_number (string / required) - The PAN number you want to verify.
#### Sample Response (200 OK)
```json
{
"response_status_id": 0,
"data": {
"upstream_rrn": "pan_abc123xyz",
"pan_no": "ABCDE1234F",
"fullname": "JOHN DOE",
"category": "person",
"status": "success"
},
"response_type_id": 0,
"status": 0
}1.2. PAN Comprehensive API
| "middlename": "", | ||
| "pan_status": "valid", | ||
| "masked_aadhaar": "", | ||
| "message": "pan verification successful", |
There was a problem hiding this comment.
The success message is grammatically incorrect and inconsistent with capitalization used elsewhere for acronyms. "PAN" is an acronym and should be capitalized for consistency.
| "message": "pan verification successful", | |
| "message": "PAN verification successful", |
| "gstin_status": "valid", | ||
| "pan_no": "XXXXX0000X", | ||
| "state": "Gujarat", | ||
| "message": "GST by pan verification successful", |
There was a problem hiding this comment.
For consistency and correctness, the acronym "PAN" in the success message should be capitalized.
| "message": "GST by pan verification successful", | |
| "message": "GST by PAN verification successful", |
| "response_status_id": 0, | ||
| "data": { | ||
| "number": "UXXXXXX0000XXXX000000", | ||
| "data": { |
There was a problem hiding this comment.
The sample response for CIN Verification contains a nested data field (data.data), which can be confusing for developers. It's a good practice to use descriptive and non-repetitive names for fields. Consider renaming the inner data field to something more specific like cin_details or company_data to improve the API's usability.
| "data": { | |
| "cin_details": { |
| }, | ||
| "client_id": "company_XXXXXXXXXXXXXXXXXXXX" | ||
| }, | ||
| "message": "CIN verification successfully", |
There was a problem hiding this comment.
The success message uses an adverb "successfully" where an adjective "successful" is expected. For correct grammar and consistency with other messages, please change it to "successful".
| "message": "CIN verification successfully", | |
| "message": "CIN verification successful", |
| - initiator_id (string / required) - Your registered mobile number. | ||
| - user_code (string / required) - User code value of the retailer from whom the request is coming. | ||
| - dl_number (string / required) - The Driving License number. | ||
| - dob (string / required) - Date of birth of the DL holder. |
There was a problem hiding this comment.
The documentation for the dob parameter doesn't specify the expected date format. This can lead to confusion and integration errors. For consistency with other APIs in this document (e.g., PAN Lite, Passport), please specify the required format, for example, YYYY-MM-DD.
| - dob (string / required) - Date of birth of the DL holder. | |
| - dob (string / required) - Date of birth of the DL holder in YYYY-MM-DD format. |
| "ECHALLAN" | ||
| ] | ||
| }, | ||
| "message": "Echallan fetch successfully", |
There was a problem hiding this comment.
The success message has a typo ("Echallan" instead of "E-challan") and awkward phrasing. To improve clarity and consistency with the section heading, please correct the message.
| "message": "Echallan fetch successfully", | |
| "message": "E-challan fetch successful", |
2 participants
Added Touras Apis