Skip to main content

Fetch Customer details for Loan Id

GET Customer Details for Loan Id

This Synofin API retrieves all the essential customer information using this Loan Viewer API using Loan Id.

Screenshot 2023-04-20 at 1.36.11 AM.png

URL: {{base_url}}/loan-management/v1/getCustomerDetails

Run in Postman: GET Customer Details

Request: 

Request Type: GET
Authorization: Bearer Token
Query Parameter:
Key Data Type Description Validations Default Value Required
loanId Integer Unique identity constraint  N/A - Yes


Response:

Success: 200 OK
Schema
Attribute

Type  Description Mandatory
response

Boolean Internal status code that denotes the status of requests Yes
data


Array of Object













































































































































id

Integer

customer_type

String

basic_info

Object















































first_name
String

middle_name
String

last_name
String

dob
date

documents
Array










description String

document_url String

document_value String

is_verified Boolean

applicant_type String

customer_name String

other_document_name String

document_type String

gender
String

guardian_name
String

maidens_name
String

marital_status
String

category
String

religion
String

cibil
integer

caste
String

crif
Integer

bureau_score
Integer

registration_number
integer

registration_type
String

industry
String

sub_industry
String

website
String

partnership_percentage
String

authorized_signatory
String

applicant_type
String

customer_relationship_id
String

relationship_with_applicant
String

relationship_with_co_applicant
String

profile_picture_url
String

is_individual
Boolean

constitution_type
String

msme_flag
String

msme_subtype
String

customer_category
String

commercial_bureau_score
String

kyc_risk_categorization
String

equifax
String

education_qualification
String

global_customer_id
String

scf_customer_type
String

communication

Array of Object







numbers
String

state
String

address_type
String

is_address_type_primary
Boolean

full_address
String

pin_code
String

whatsapp_number
String

email_id
String

city
String

business_info

Array of Object


























earner
Boolean

occupation_type
String

company_or_firm_name
String

designation
String

gross_monthly_income
Integer

total_work_experience
integer

major_occupation
Boolean

full_address
String

landmark
String

pin_code
String

state
String

district
String

city
String

phone
String

preferred_communication
String

msme
String

ownership
String

total_expense
integer

udyog_aadhar
String

loan_net_worth
Number

monthly_purchase
Number

monthly_sale
Number

total_year_of_operation
Integer

nature_of_business
Integer

business_type
String

family_information

Array of Object














relation_with_applicant
String

name
String

education_qualification
String

degree_name
String

age
integer

contact_number
String

occupation
String

dependents
String

is_occupation_same_as_applicant
boolean

living_with_applicant
boolean

medical_condition
String

remarks
String

maiden_name
String

in_law_details

Array of Object

references

Array of Object







relation
String

name
String

phone_number
String

address
String

remarks
String

occupation
String

bank_details

Array of Object
















bank_name
String

branch_name
String

branch_ifsc
String

account_type
String

account_number
String

is_repayment_account
Boolean

is_default_account
boolean

id
Integer

bank_document
String

nach_detail
String

umrn_no
String

customer_name
String

branch_code
String

bank_details
String

customer_id
String

basic_info_non_individual

Array of Object


















customer_category
String

key_person_name
String

constitution_type
String

gst_number
String

website
String

partnership_percentage
Integer

industry
String

sub_industry
String

msme_flag
String

msme_subtype
String

commercial_bureau_score
Integer

kyc_risk_categorization
Integer

living_since_current_city
Integer

months_at_current_address
Integer

months_at_current_city
Integer

years_at_current_address
Integer

years_at_current_city
Integer


nominees_details





nominees_details





relationship_with_co_applicant




error
String

Body
{
   "response": true,
   "data": [
      {
         "id": 1529,
         "customer_type": "string",
         "basic_info": {
            "first_name": "string",
            "middle_name": "string",
            "last_name": "string",
            "dob": "01/07/1997",
            "documents": [
               {
                  "description": "string",
                  "document_url": "string",
                  "document_value": "string",
                  "is_verified": "boolean",
                  "applicant_type": "string",
                  "customer_name": "string",
                  "other_document_name": "string",
                  "document_type": "string"
               }
            ],
            "gender": "string",
            "guardian_name": "string",
            "maidens_name": "string",
            "marital_status": "string",
            "category": "string",
            "religion": "string",
            "cibil": 0,
            "caste": "string",
            "crif": "string",
            "bureau_score": 0,
            "registration_number": null,
            "registration_type": null,
            "industry": null,
            "sub_industry": null,
            "website": null,
            "partnership_percentage": null,
            "authorized_signatory": null,
            "applicant_type": "string",
            "customer_relationship_id": "string",
            "relationship_with_applicant": null,
            "relationship_with_co_applicant": null,
            "profile_picture_url": "string",
            "is_individual": true,
            "constitution_type": "",
            "msme_flag": null,
            "msme_subtype": null,
            "customer_category": "string",
            "commercial_bureau_score": null,
            "kyc_risk_categorization": null,
            "equifax": null,
            "education_qualification": "string",
            "global_customer_id": "string",
            "scf_customer_type": "null"
         },
         "communication": [
            {
               "numbers": "string",
               "state": "string",
               "address_type": "string",
               "is_address_type_primary": "boolean",
               "full_address": "string",
               "pin_code": "string",
               "whatsapp_number": null,
               "email_id": "-",
               "city": "string"
            }
         ],
         "business_info": {
            "earner": true,
            "occupation_type": "string",
            "company_or_firm_name": "string ",
            "designation": "",
            "gross_monthly_income": 0,
            "total_work_experience": 0,
            "major_occupation": true,
            "full_address": "string",
            "landmark": "string",
            "pin_code": "string",
            "state": null,
            "district": null,
            "city": null,
            "phone": "",
            "preferred_communication": null,
            "msme": null,
            "ownership": null,
            "total_expense": null,
            "udyog_aadhar": null,
            "loan_net_worth": 0,
            "monthly_purchase": null,
            "monthly_sale": null,
            "total_year_of_operation": null,
            "nature_of_business": "",
            "business_type": ""
         },
         "insurance_data": [],
         "family_information": [
            {
               "relation_with_applicant": null,
               "name": "string",
               "education_qualification": "string",
               "degree_name": null,
               "age": 20,
               "contact_number": "string",
               "occupation": null,
               "dependents": "",
               "is_occupation_same_as_applicant": false,
               "living_with_applicant": false,
               "medical_condition": "string",
               "remarks": null,
               "maiden_name": null
            }
         ],
         "in_law_details": null,
         "references": [
            {
               "relation": null,
               "name": "string",
               "phone_number": "string",
               "address": "string",
               "remarks": null,
               "occupation": null
            }
         ],
         "obligation": null,
         "bank_details": [
            {
               "bank_name": "string",
               "branch_name": null,
               "branch_ifsc": "string",
               "account_type": null,
               "account_number": "string",
               "is_repayment_account": null,
               "is_default_account": null,
               "id": 0,
               "bank_document": null,
               "nach_detail": null,
               "umrn_no": null,
               "customer_name": null,
               "branch_code": null,
               "bank_details": null,
               "customer_id": null
            }
         ],
         "basic_info_non_individual": {
            "customer_category": "string",
            "key_person_name": "",
            "constitution_type": "",
            "registration_type": null,
            "gst_number": "",
            "website": null,
            "partnership_percentage": 0,
            "industry": null,
            "sub_industry": null,
            "msme_flag": null,
            "msme_subtype": null,
            "commercial_bureau_score": null,
            "kyc_risk_categorization": null,
            "living_since_current_city": null,
            "months_at_current_address": null,
            "months_at_current_city": null,
            "years_at_current_address": null,
            "years_at_current_city": null
         },
         "nominees_details": null,
         "relationship_with_applicant": null,
         "relationship_with_co_applicant": null,
         "institution_info": []
      }
   ],
   "error": null
}

Bad Request: 400

Note: If the API is unable to retrieve data for specific fields against the relevant Loan Id, then this error will occur.

Schema
Attribute

Type Description Mandatory
response
String Internal status code that denotes the status of request Yes
data
Object Response Object for the given inputs No
error Object Data Object Internal error object for the given inputs Yes

code integer Internal error code for API Yes
text String Error message for the API No
detail String Reason / Detail for the cause of error No
Body
Expected messages as per Status API :
Error Code Description
107001 An Exception occurred in saving data
{
    "response": false,
    "data": null,
    "error": {
        "code": 0,
        "text": "string",
        "detail": "string"
    }
}

Unauthorized: 401

Note: If the API is not authorized with the Token or if the authorization token has expired, this error is going to show up.

Body
{
    "code": 401,
    "message": "auth fail, you can retry!"
}