GujRera
1 endpoint · Core API
Verify Gujarat RERA project by registration number
docs.signcare.io/core/api/business-registration/gujrera/#post-api-v1-gujrera-verify
Request body: registration_no (required) is the project registration number, matched exactly as registered (including slashes, spaces and letter case). consent and consent_text are required; request_id is optional.
Returns 404 when no record exists for the registration number.
Headers
- X-API-KEYstringrequiredYour secret API key for the environment you are calling (Stage and Live use different keys).
- X-API-APP-IDstringrequiredThe App ID issued together with the key.
- Content-Typestringrequiredapplication/json
Body parameters
application/json- consentstringrequiredRequired. The end user's consent to this verification. Send `Y`.minLength 1default Y
- consent_textstringrequiredRequired. The consent statement shown to the end user. Send the default text from the sample.minLength 1default I hear by declare my consent agreeme…
- request_idstringoptionalOptional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.nullable
- registration_nostringrequiredRequired. Gujarat RERA project registration number, e.g. "PR/GJ/AHMEDABAD/AHMADABAD CITY/AUDA/RAA00006/A1R/151218". It is matched exactly as registered, including slashes, spaces and letter case.minLength 1default PR/GJ/AHMEDABAD/AHMADABAD CITY/AUDA/…
Sample request body
{
"consent": "Y",
"consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API",
"registration_no": "PR/GJ/AHMEDABAD/AHMADABAD CITY/AUDA/RAA00006/A1R/151218"
}
Responses
200OK
- successbooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 200
- messagestringoptionalNo description.nullabledefault XXXXX
- dataobjectoptionalResponse model containing Gujarat RERA project verification details.
5 fields
- registration_nostringoptionalNo description.nullable
- project_infoobjectoptionalNo description.
16 fields
- project_namestringoptionalNo description.nullable
- project_typestringoptionalNo description.nullable
- project_addressstringoptionalNo description.nullable
- talukastringoptionalNo description.nullable
- districtstringoptionalNo description.nullable
- statestringoptionalNo description.nullable
- project_start_datestringoptionalNo description.nullable
- project_end_datestringoptionalNo description.nullable
- plan_passing_authoritystringoptionalNo description.nullable
- is_redevelopment_projectbooleanoptionalNo description.
- is_affordable_housingbooleanoptionalNo description.
- carpet_area_of_unitsnumber (double)optionalNo description.
- total_open_areanumber (double)optionalNo description.
- total_covered_areanumber (double)optionalNo description.
- project_estimated_costnumber (double)optionalNo description.
- certificate_urlstringoptionalNo description.nullable
- collection_bankobjectoptionalNo description.
3 fields
- bank_namestringoptionalNo description.nullable
- ac_numberstringoptionalNo description.nullable
- ifsc_codestringoptionalNo description.nullable
- promoterobjectoptionalNo description.
6 fields
- namestringoptionalNo description.nullable
- typestringoptionalNo description.nullable
- addressstringoptionalNo description.nullable
- contactstringoptionalNo description.nullable
- email_idstringoptionalNo description.nullable
- partnersstringoptionalNo description.nullable
- promoter_profileobjectoptionalNo description.
11 fields
- years_of_experience_in_gujaratinteger (int64)optionalNo description.
- bank_namestringoptionalNo description.nullable
- branch_namestringoptionalNo description.nullable
- contactstringoptionalNo description.nullable
- email_idstringoptionalNo description.nullable
- total_completed_projectsinteger (int64)optionalNo description.
- total_ongoing_projectsinteger (int64)optionalNo description.
- total_projects_carried_outinteger (int64)optionalNo description.
- total_area_constructed_till_datenumber (double)optionalNo description.
- total_covered_areanumber (double)optionalNo description.
- total_open_areanumber (double)optionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- isBillablebooleanoptionalWhether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.
Example
{
"success": false,
"statusCode": 200,
"message": "XXXXX",
"data": {
"registration_no": "string",
"project_info": {
"project_name": "string",
"project_type": "string",
"project_address": "string",
"taluka": "string",
"district": "string",
"state": "string",
"project_start_date": "string",
"project_end_date": "string",
"plan_passing_authority": "string",
"is_redevelopment_project": false,
"is_affordable_housing": false,
"carpet_area_of_units": 0,
"total_open_area": 0,
"total_covered_area": 0,
"project_estimated_cost": 0,
"certificate_url": "string"
},
"collection_bank": {
"bank_name": "string",
"ac_number": "string",
"ifsc_code": "string"
},
"promoter": {
"name": "string",
"type": "string",
"address": "string",
"contact": "string",
"email_id": "string",
"partners": "string"
},
"promoter_profile": {
"years_of_experience_in_gujarat": 0,
"bank_name": "string",
"branch_name": "string",
"contact": "string",
"email_id": "string",
"total_completed_projects": 0,
"total_ongoing_projects": 0,
"total_projects_carried_out": 0,
"total_area_constructed_till_date": 0,
"total_covered_area": 0,
"total_open_area": 0
}
},
"messages": [
"string"
],
"request_id": "string",
"isBillable": false
}
400Bad Request
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 400
Example
{
"data": {},
"messages": [
"string"
],
"request_id": "string",
"success": false,
"message": "XXXXX",
"isBillable": false,
"statusCode": 400
}
401Unauthorized
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 401
Example
{
"data": {},
"messages": [
"string"
],
"request_id": "string",
"success": false,
"message": "XXXXX",
"isBillable": false,
"statusCode": 401
}
429Too Many Requests
- successbooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 200
- messagestringoptionalNo description.nullabledefault XXXXX
- dataanyoptionalNo description.nullable
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- isBillablebooleanoptionalWhether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.
Example
{
"success": false,
"statusCode": 200,
"message": "XXXXX",
"data": null,
"messages": [
"string"
],
"request_id": "string",
"isBillable": false
}
500Internal Server Error
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 500
Example
{
"data": {},
"messages": [
"string"
],
"request_id": "string",
"success": false,
"message": "XXXXX",
"isBillable": false,
"statusCode": 500
}
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/api/v1/GujRera/verify' \
-H 'X-API-KEY: YOUR_API_KEY' \
-H 'X-API-APP-ID: YOUR_APP_ID' \
-H 'Content-Type: application/json' \
-d '{
"consent": "Y",
"consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API",
"registration_no": "PR/GJ/AHMEDABAD/AHMADABAD CITY/AUDA/RAA00006/A1R/151218"
}'