Crego APIs
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
  1. APIs Doc
  • Back to home
  • Sample Flow
  • Send Otp
    POST
  • Submit Otp
    POST
  • Create Runner
    POST
  • PAN or GST
    POST
  • Business Info
    POST
  • Shareholders
    POST
  • Business Extraa Info
    POST
  • Business Assest Detail
    POST
  • Applicant List
    GET
  • Submit Application
    POST
  • Set Current Applicant
    POST
  • Document upload
    POST
  • Get Document
    GET
  • Applicant Pan , Aadhaar and Mobile
    POST
  • Applicant Extraa Info
    POST
  • Applicant Bank Details
    POST
  • Signing Form
    POST
  1. APIs Doc

Business Info

Developing
preprod
https://preprod.api.crego.io
preprod
https://preprod.api.crego.io
POST
/v1/rego/runners/{runner_id}/execute/
Last modified:2025-03-05 13:50:26

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
runner_id
string 
required
Example:
{{runner_id}}
Body Params application/json
action
string 
required
data
object 
required
business
object 
required
Example
{
    "action": "submit",
    "data": {
        "business": {
            "name": "Barbara Murphy",
            "corporation_date": "2659-76-98",
            "gst_no": "37ZAWEY0814N9X7",
            "email": "YN@x82.kF",
            "geolocation": "sit id",
            "business_proof": {
                "name": "Current Account Passbook",
                "document_id": "cillum sed"
            },
            "registered_address": {},
            "current_address": {
                "same_as_registered_address": false
            }
        }
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://preprod.api.crego.io/v1/rego/runners/{{runner_id}}/execute/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "submit",
    "data": {
        "business": {
            "name": "Barbara Murphy",
            "corporation_date": "2659-76-98",
            "gst_no": "37ZAWEY0814N9X7",
            "email": "YN@x82.kF",
            "geolocation": "sit id",
            "business_proof": {
                "name": "Current Account Passbook",
                "document_id": "cillum sed"
            },
            "registered_address": {},
            "current_address": {
                "same_as_registered_address": false
            }
        }
    }
}'

Responses

🟢200Success
application/json
Body
id
string 
required
created_at
string 
required
updated_at
string 
required
created_by
string 
required
ref_id
string 
required
flow_id
string 
required
design_id
string 
required
params
object 
required
storage
object 
required
current_node
string 
required
store_id
string 
required
visited_nodes
object 
required
_cls
string 
required
store_info
object 
required
data
object 
required
_status_code
integer 
required
success
boolean 
required
stage
string 
required
body
object 
required
errorMetaData
array [object {1}] 
required
node
object 
required
name
string 
required
type
string 
required
config
object 
required
navigations
array [object {2}] 
required
Example
{
    "id": "c296a37d-f11d-4d32-bff8-5824a1af5ed9",
    "created_at": "2025-03-05T13:38:23.683000",
    "updated_at": "2025-03-05T13:51:47.742764",
    "created_by": "7880340889",
    "ref_id": "RUNNER-253-647",
    "flow_id": "264500a4-3873-4cb7-baf9-0a4656bff933",
    "design_id": "234ee7a1-6940-49f1-bd7e-d23f1b2625d0",
    "params": {
        "storage": {
            "vendor": "${SECRET.storage.vendor}",
            "creds_key": "test_storage_s3_creds"
        }
    },
    "current_node": "shareholders",
    "store_id": "52bcdaf3-6e98-4647-9eb3-acac6dd1d516",
    "visited_nodes": {
        "_cls": "Activity"
    },
    "store_info": {},
    "data": {
        "_status_code": 200,
        "success": true,
        "stage": "FirstHit",
        "body": {
            "createdAt": "2025-01-08T07:44:48.000Z",
            "modifiedAt": "2025-02-24T12:20:15.000Z",
            "source": "Fundly",
            "secondarySource": "",
            "leadId": "KN_LEAD_IDfa3478650ce",
            "applicationId": "",
            "customerStatus": "New",
            "data": {
                "EligibilityStageData": {
                    "mobile": "7880340889",
                    "consent": 1,
                    "customerName": "Niranjana Devi",
                    "personalPAN": "",
                    "businessName": "",
                    "businessVintage": "",
                    "businessPinCode": "",
                    "avgMonthlyTurnover": "",
                    "requiredLoanAmount": "",
                    "eligibleProducts": "",
                    "existinCustomerInfo": null,
                    "leadgenV2Response": "",
                    "individualkycs": {
                        "maskedaadhar": "",
                        "aadhar": ""
                    },
                    "businesskycs": {
                        "gstno": "29AAZCS9478E1Z7",
                        "ssino": "",
                        "s&e": "",
                        "pan": "",
                        "udyamregistration": "",
                        "tradelicensecertificate": "",
                        "factoryregistrationcertificate": "",
                        "salestaxcertificate": "",
                        "memorandumofassociation": "",
                        "articlesofassociation": "",
                        "boardresolutioncertificate": "",
                        "certificateofincorporation": "",
                        "districtindustrialcertificate": "",
                        "localauthoritycertificate": "",
                        "msme": "",
                        "tin": "",
                        "dic": ""
                    },
                    "coAppKYC": [
                        {
                            "type": "coApp2",
                            "mobile": "7032392379",
                            "kycs": [
                                {
                                    "type": "pan",
                                    "value": "AMWPC5159L"
                                }
                            ]
                        }
                    ],
                    "guarantorKYC": []
                },
                "entityIdDetails": [
                    {
                        "type": "business",
                        "value": {
                            "id": 1425961,
                            "mobile_phone": "7880340889",
                            "mobile_number_2": null,
                            "whats_app_mobile_no": null,
                            "KYC_IDTYPE": "GST",
                            "KYC_IDNUM": "29AACCG0527D1Z0",
                            "created_at": "2025-02-24T06:11:48.000Z",
                            "autoUpdateAt": "2025-02-24T06:11:48.000Z",
                            "ENTITY_ID": "EN13526788",
                            "ENTITY_STATUS": 1,
                            "ENTITY_TYPE": "Business",
                            "dob": null,
                            "gender": null,
                            "ckycNumber": null,
                            "ckycStatus": null,
                            "source": "LOS",
                            "aadhar_hash": null,
                            "masked_aadhar_hash": null,
                            "loan_created": null,
                            "loan_disbursed": null,
                            "ovd_expiry_date": null
                        }
                    }
                ],
                "urnDetails": {
                    "applicant": {
                        "primary_urn": "",
                        "secondary_urn": "",
                        "business_urn": ""
                    },
                    "coApplicant": [
                        {
                            "type": "coApp1",
                            "value": {}
                        },
                        {
                            "type": "coApp2",
                            "value": {
                                "primary_urn": "",
                                "secondary_urn": "",
                                "business_urn": ""
                            }
                        },
                        {
                            "type": "coApp3",
                            "value": {}
                        },
                        {
                            "type": "coApp4",
                            "value": {}
                        }
                    ],
                    "gurantor": [
                        {
                            "type": "gurantor1",
                            "value": {}
                        },
                        {
                            "type": "gurantor2",
                            "value": {}
                        },
                        {
                            "type": "gurantor3",
                            "value": {}
                        }
                    ],
                    "business": {}
                },
                "sourceParameters": {
                    "name": "fundly",
                    "data": {
                        "applicationId": "",
                        "loanOfficerId": "",
                        "geoLocation": "",
                        "campaign": {
                            "device": null,
                            "placement": null,
                            "gclid": null,
                            "keyword": null,
                            "language": null,
                            "utm_campaign": null,
                            "utm_id": "",
                            "utm_source": "",
                            "utm_medium": null,
                            "utm_term": null,
                            "utm_content": null,
                            "Adgroup_Brand": null
                        }
                    }
                }
            }
        },
        "errorMetaData": [
            {
                "code": ""
            }
        ]
    },
    "node": {
        "name": "shareholders",
        "type": "web_form",
        "config": {
            "forms": [
                {
                    "action": "submit",
                    "form_data": {
                        "applicants": [
                            {
                                "name": "KENNETH HOHEE YI"
                            },
                            {
                                "name": "ROBERT EARNEST ANDREATTA"
                            },
                            {
                                "name": "FIONA MARY BONES"
                            },
                            {
                                "name": "KASHIMAT VISHWANATHASWAMY VISHNU PRASAD"
                            }
                        ],
                        "number_of_shareholders": ""
                    },
                    "schema": {
                        "definitions": {
                            "applicant": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "title": "Applicant Name"
                                    },
                                    "tags": {
                                        "type": "array",
                                        "title": "Applicant Roles",
                                        "items": {
                                            "type": "string",
                                            "enum": [
                                                "Authorised Signatory",
                                                "Director",
                                                "Partner",
                                                "Shareholder",
                                                "Guarantor"
                                            ]
                                        },
                                        "uniqueItems": true
                                    },
                                    "applicant_type": {
                                        "type": "string",
                                        "title": "Applicant Type",
                                        "oneOf": [
                                            {
                                                "const": "applicant",
                                                "title": "Primary Applicant"
                                            },
                                            {
                                                "const": "CoApp1",
                                                "title": "Applicant 1"
                                            },
                                            {
                                                "const": "CoApp2",
                                                "title": "Applicant 2"
                                            },
                                            {
                                                "const": "CoApp3",
                                                "title": "Applicant 3"
                                            },
                                            {
                                                "const": "CoApp4",
                                                "title": "Applicant 4"
                                            },
                                            {
                                                "const": "CoApp5",
                                                "title": "Applicant 5"
                                            },
                                            {
                                                "const": "CoApp6",
                                                "title": "Applicant 6"
                                            }
                                        ]
                                    }
                                },
                                "required": [
                                    "name",
                                    "tags",
                                    "applicant_type"
                                ],
                                "dependencies": {
                                    "applicant_type": {
                                        "oneOf": [
                                            {
                                                "properties": {
                                                    "applicant_type": {
                                                        "const": "applicant"
                                                    }
                                                }
                                            },
                                            {
                                                "properties": {
                                                    "applicant_type": {
                                                        "not": {
                                                            "const": "applicant"
                                                        }
                                                    },
                                                    "relation_with_primary_applicant": {
                                                        "type": "string",
                                                        "title": "Relation with Primary Applicant",
                                                        "enum": [
                                                            "Friend",
                                                            "Father",
                                                            "Mother",
                                                            "Brother",
                                                            "Sister",
                                                            "Husband",
                                                            "Wife",
                                                            "Son",
                                                            "Daughter",
                                                            "Other"
                                                        ]
                                                    }
                                                },
                                                "required": [
                                                    "relation_with_primary_applicant"
                                                ]
                                            }
                                        ]
                                    },
                                    "tags": {
                                        "oneOf": [
                                            {
                                                "properties": {
                                                    "tags": {
                                                        "contains": {
                                                            "const": "Shareholder"
                                                        }
                                                    },
                                                    "share_holder": {
                                                        "type": "number",
                                                        "title": "Shareholder %",
                                                        "minimum": 0,
                                                        "maximum": 100,
                                                        "description": "Enter a percentage value between 0 and 100."
                                                    }
                                                },
                                                "required": [
                                                    "share_holder"
                                                ]
                                            },
                                            {
                                                "properties": {
                                                    "tags": {
                                                        "not": {
                                                            "contains": {
                                                                "const": "Shareholder"
                                                            }
                                                        }
                                                    },
                                                    "share_holder": false
                                                }
                                            }
                                        ]
                                    }
                                }
                            }
                        },
                        "type": "object",
                        "properties": {
                            "number_of_shareholders": {
                                "type": "number",
                                "title": "Number of Shareholders",
                                "minimum": 1,
                                "maximum": 10
                            },
                            "applicants": {
                                "type": "array",
                                "title": "Applicants",
                                "items": {
                                    "$ref": "#/definitions/applicant"
                                }
                            }
                        },
                        "required": [
                            "applicants"
                        ]
                    },
                    "ui": {
                        "applicants": {
                            "ui:widget": "list",
                            "ui:config": {
                                "can_add": true,
                                "can_edit": true,
                                "can_delete": true,
                                "items": [
                                    {
                                        "type": "tag",
                                        "tag": "h5",
                                        "value": "name"
                                    },
                                    {
                                        "type": "badges",
                                        "value": "tags"
                                    }
                                ]
                            },
                            "items": {
                                "tags": {
                                    "ui:widget": "select2"
                                },
                                "applicant_type": {
                                    "ui:widget": "select"
                                },
                                "relation_with_primary_applicant": {
                                    "ui:widget": "select"
                                }
                            }
                        }
                    }
                }
            ]
        },
        "navigations": [
            {
                "action_name": null,
                "target_node": "business_info"
            }
        ]
    }
}
Previous
PAN or GST
Next
Shareholders
Built with