DMA-Server-Cus API

Operations
Customer
POST /application/consult-registration
POST /customer/change-password
POST /customer/change-password-first-time
POST /customer/forgot-password
POST /customer/login
POST /customer/logout
POST /customer/registering
POST /customer/show-intro
POST /lead-map/request-consult
POST /customer/change-password/{otp}
GET /customer/credit-info/{leadid}
POST /customer/credit-info/{leadid}
GET /customer/document-checklist/{leadid}
POST /customer/document-checklist/{leadid}
GET /customer/document-upload/{leadid}
POST /customer/document-upload/{leadid}
POST /customer/newapp/create
POST /customer/registering/password
POST /customer/{application_id}/accept-approval
POST /customer/application/drop/{leadid}
POST /customer/collateral-owner/save/{leadid}
POST /customer/document/drop/{leadid}
POST /customer/forgot-password/verify/{otp}
POST /customer/house-lease-incomes/save/{leadid}
POST /customer/newapp/create/{leadid}
POST /customer/preloan/save/{leadid}
POST /customer/preperson/save/{leadid}
POST /customer/registering/verify/{otp}
POST /customer/salary-incomes/save/{leadid}
GET /customer/applications
GET /customer/customer-projects
GET /customer/profile
GET /customer/video-list
GET /customer/application/{application_id}
GET /customer/customer-projects/branch-regions
GET /customer/customer-projects/{project_id}
GET /customer/preloan/{leadid}
GET /customer/preperson/{leadid}
GET /customer/salary-incomes/{leadid}
GET /customer/{application_id}/get-customer-disbursement-status
GET /customer/{application_id}/documents
GET /customer/{application_id}/approval-result
GET /customer/application/{application_id}/document
GET /customer/change-password/verify/{token}
GET /customer/newapp/prefill/{leadid}
GET /customer/prospect/registering/{leadid}/{phonenumber}
Customer request consult
POST /application/consult-registration

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer change Password
POST /customer/change-password

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer change Password
POST /customer/change-password-first-time

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer Forgot Password
POST /customer/forgot-password

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer Login
POST /customer/login

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer Logout
POST /customer/logout

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer account register
POST /customer/registering

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Update status show intro
POST /customer/show-intro

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
500 500

Bad Request

Body
Customer request consult
POST /lead-map/request-consult

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer verify otp code
POST /customer/change-password/{otp}

Path variables

otp
string required
Default:

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get salary incomes
GET /customer/credit-info/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save credit information
POST /customer/credit-info/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get pre document checklist info
GET /customer/document-checklist/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save pre document checklist
POST /customer/document-checklist/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get pre document checklist info
GET /customer/document-upload/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer upload document
POST /customer/document-upload/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

multipart/form-data
string binary
title
string required

Responses

200 200

Success

Body
400 400

Bad Request

Body
create new preApplication
POST /customer/newapp/create

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save new account
POST /customer/registering/password

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Approve the application
POST /customer/{application_id}/accept-approval

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
string
400 400

Bad Request

Body
Customer drop application
POST /customer/application/drop/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save collateral owner
POST /customer/collateral-owner/save/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Delete document
POST /customer/document/drop/{leadid}

Path variables

leadid
string required

Request parameters

category
string required
Pattern: ^[^<>:;,?"*|\/]+$
file_name
string required
Pattern: ^[^<>:;,?"*|\/]+$
document_key
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer verify otp code
POST /customer/forgot-password/verify/{otp}

Path variables

otp
string required
Default:

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save house lease preIncomes
POST /customer/house-lease-incomes/save/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
create new preApplication
POST /customer/newapp/create/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save preLoanPreference
POST /customer/preloan/save/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save prePerson
POST /customer/preperson/save/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer verify otp code
POST /customer/registering/verify/{otp}

Path variables

otp
string required
Default:

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer save preLoanPreference
POST /customer/salary-incomes/save/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get customer applications
GET /customer/applications

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get all customer projects information
GET /customer/customer-projects

Request parameters

lang
string required
Default:
vn

Responses

200 200

Success

Body
400 400

Bad Request

Body
Customer get profile information
GET /customer/profile

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get all customer projects information
GET /customer/video-list

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get all data for application
GET /customer/application/{application_id}

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get branch info by project_code
GET /customer/customer-projects/branch-regions

Request parameters

project_code
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get a customer project information details
GET /customer/customer-projects/{project_id}

Path variables

project_id
number required

Request parameters

lang
string required
Default:
vn

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get preLoanPreference info
GET /customer/preloan/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get prePerson info
GET /customer/preperson/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get salary incomes
GET /customer/salary-incomes/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Gets customer disbursement status
GET /customer/{application_id}/get-customer-disbursement-status

Path variables

application_id
string required
Default:
1

Responses

200 200

Success

Body
400 400

Bad Request

Body
Update status show intro
GET /customer/{application_id}/documents

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
500 500

Bad Request

Body
Get approval result
GET /customer/{application_id}/approval-result

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
string
400 400

Bad Request

Body
Download document
GET /customer/application/{application_id}/document

Path variables

application_id
string required
Default:
1

Request parameters

category
string required
Pattern: ^[^<>:;,?"*|\/]+$
file_name
string required
Pattern: ^[^<>:;,?"*|\/]+$

Request headers

Authorization
string optional

Responses

200 200

Success

Body
string
400 400

Bad Request

Body
Customer Change Password Verify
GET /customer/change-password/verify/{token}

Path variables

token
string required
Default:
1

Responses

200 200

Success

Body
400 400

Bad Request

Body
get data preFill for new preApplication
GET /customer/newapp/prefill/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
customer register from prospect
GET /customer/prospect/registering/{leadid}/{phonenumber}

Path variables

leadid
string required
phonenumber
string required

Responses

200 200

Success

Body
400 400

Bad Request

Body
PreApplication
POST /customer/current-step/{leadid}
POST /customer/submit/{leadid}
GET /customer/preapp-info/{leadid}
GET /customer/preapp-info/view/{leadid}
save current step
POST /customer/current-step/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Request body

Responses

200 200

Success

Body
400 400

Bad Request

Body
submit preapplication
POST /customer/submit/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get preApplication info
GET /customer/preapp-info/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get preApplication info
GET /customer/preapp-info/view/{leadid}

Path variables

leadid
string required

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Miscellaneous
Get all branch informations
GET /branches

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get all project informations
GET /projects

Request parameters

uniq
boolean optional
Default:
false

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Application
GET /application/{application_id}
GET /application/{application_id}/income
GET /application/{application_id}/credit_info
GET /application/{application_id}/collateral
GET /application/{application_id}/personal-info
GET /customer/{leadid}/document
GET /application/{application_id}/document/checklist
GET /application/{application_id}/document/list
Get all data for application
GET /application/{application_id}

Path variables

application_id
string required
Default:
1

Request parameters

edited
boolean optional

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Prefill source of income
GET /application/{application_id}/income

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Prefill credit info
GET /application/{application_id}/credit_info

Path variables

application_id
string required
Default:
1

Request parameters

edited
boolean optional

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Prefill collateral info
GET /application/{application_id}/collateral

Path variables

application_id
string required
Default:
1

Request parameters

edited
boolean optional

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Prefill personal info
GET /application/{application_id}/personal-info

Path variables

application_id
string required
Default:
1

Request parameters

edited
boolean optional

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Download document
GET /customer/{leadid}/document

Path variables

leadid
string required

Request parameters

category
string required
Pattern: ^[^<>:;,?"*|\/]+$
file_name
string required
Pattern: ^[^<>:;,?"*|\/]+$

Request headers

Authorization
string optional

Responses

200 200

Success

Body
string
400 400

Bad Request

Download document checklist
GET /application/{application_id}/document/checklist

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
List contents of directory
GET /application/{application_id}/document/list

Path variables

application_id
string required
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Server
GET /server/health-check
GET /server/logs
GET /server/version
PUT /server/cache/{group}/flush
Check server status
GET /server/health-check

Responses

200 200

Internal Server Error

Body
500 500

Internal Server Error

Body
Get logs
GET /server/logs

Responses

200 200

Bad Request

Body
500 500

Internal Error

Body
Check server version
GET /server/version

Responses

200 200

Internal Server Error

Body
500 500

Internal Server Error

Body
Flush server cache
PUT /server/cache/{group}/flush

Path variables

group
string required

Responses

200 200

Internal Server Error

Body
500 500

Internal Server Error

Body
Contracting
GET /contracting/{application_id}/document
GET /contracting/{application_id}/credit-information
GET /contracting/{application_id}/list-of-generated-documents
Download document
GET /contracting/{application_id}/document

Path variables

application_id
string required
Default:
1

Request parameters

file_name
string required
Pattern: ^[^<>:;,?"*|\/]+$
contracting
boolean optional
project_code
string optional
contract_period
string optional
collateral_status
string optional
type_of_collateral
string optional
have_interest_support
string optional
apartment_number
string optional

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get credit information
GET /contracting/{application_id}/credit-information

Path variables

application_id
string required
Default:
1

Request parameters

times
number optional
Default:
1

Request headers

Authorization
string optional

Responses

200 200

Success

Body
400 400

Bad Request

Body
Get list of all generated documents
GET /contracting/{application_id}/list-of-generated-documents

Path variables

application_id
string required
Default:
1

Responses

400 400

Bad Request

Body
Disbursement
GET /disbursement/{application_id}/disbursement-count
Get number of disbursements by application id
GET /disbursement/{application_id}/disbursement-count

Path variables

application_id
string required
Default:
1

Responses

200 200

Success

Body
400 400

Bad Request

Body
Type Definitions
Model 1
Object
fullName
string required
phoneNumber
string required
Pattern: ^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
project_code
string required
project_name
string
email
string
branch_code
string
Model 2
Object
statusCode
number
message
string
Model 3
Object
statusCode
number
message
string
error
string
Model 4
Object
phoneNumber
string required
old_password
string required
new_password
string required
Model 5
Object
message
string
Enumeration:
NEW_PASSWORD_HAS_BEEN_SENT_TO_YOUR_PHONE
Model 6
Object
message
string
Enumeration:
CANNOT_SEND_SMS_TO_CUSTOMER
Model 7
Object
phoneNumber
string required
temp_password
string required
new_password
string required
Model 8
Object
phoneNumber
string required
Model 9
Object
phoneNumber
string required
password
string required
Model 10
Object
phoneNumber
string required
fullName
string required
email
string
Model 11
Object
showDashboardIntro
boolean
showApplicationDetailIntro
boolean
Model 12
Object
statusCode
number
message
string
error
string
Model 13
Object
password
string required
repassword
string required
phoneNumber
string required
Model 14
Object
loan_type
string required
bank_code
string required
bank_name
string required
credit_limit
number required
current_outstanding_loan
number required
lending_cost_per_month
number required
primary_applicant
Array of Model 14
Model 15
Object
primary_applicant
Model 16
Object
current_step
string required
Model 17
Object
Model 18
Object
projectCode
string required
projectName
string required
unit
string
identityNumber
string required
identityType
string required
agreement
boolean required
Model 19
Object
phoneNumber
string required
password
string required
repassword
string required
otp
string required
Model 20
Object
reason
string
Model 21
Object
identities_type
string required
identities_number
string required
identities
Array of Model 21
collateral_applicant
Object
name
string required
name_ascii
string required
identities
mobile_number
string required
marital_status
string required
relationship_with_customer
string required
collateral_owner_permanent_address_is_the_same_customer
boolean required
collateral_spouse
Object
name
string required
name_ascii
string required
identities
mobile_number
string
collateral_owner_permanent_address_is_the_same_customer
boolean required
spouse_authorizes_to_sign_collateral_files
boolean required
Model 22
Object
customer_is_the_owner
boolean required
authorized_to_sign_collateral_records
boolean
collateral_applicant
collateral_spouse
Model 23
Object
phoneNumber
string required
Model 24
Object
is_customer_owner
boolean required
property_ownership
string required
relationship_with_borrower
string required
area_of_the_floor
string required
total_monthly_income
string required
payment_frequency
string required
payment_method
string required
rental_experience_year
string required
rental_experience_month
string required
rent_including_furniture
boolean required
rental_contract_duration
string required
index
number
Model 25
Array of Model 24
Model 26
Object
projectCode
string required
projectName
string required
unit
string
propertyValue
number required
loanAmount
number required
loanTermInMonths
number required
identityNumber
string required
identityType
string required
agreement
boolean required
Model 27
Object
property_type
string required
purpose
string required
project_code
string required
project_name
string required
unit_number
string
property_value
number required
loan_amount
number required
loan_term_in_months
number required
principal_payment_period_in_months
string required
current_address
Object
house_number
string required
city
string required
district
string required
ward
string required
Model 28
Object
name
string required
name_ascii
string required
date_of_birth
string required
gender
string required
identities
mobile_number
string required
email
string required
marital_status
string required
number_of_dependents
number required
educational_background
string required
is_permanent_address
boolean required
years_living_in_current_address
number required
months_living_in_current_address
number required
type_of_current_home
number required
number_of_moving_times_over_5_years
number required
current_address
primary_means_of_transportation
string required
Model 29
Object
house_number
string
city
string
district
string
ward
string
spouse
Object
name
string required
name_ascii
string required
identities
educational_background
string required
spouse_current_address_is_the_same_customer
boolean required
current_address
spouse_permanent_address_is_the_same_customer
boolean required
spouse_authorizes_to_sign_credit_files
boolean required
Model 30
Object
primary_applicant
spouse
Model 31
Object
is_customer_owner
boolean required
company_name
string required
address
string required
district
number required
ward
number required
city
string required
tenure_month
number required
tenure_year
number required
work_experience_month
number required
work_experience_year
number required
current_position
string required
labour_contract_type
string required
payment_mode
string required
frequent_income
number required
index
number
Model 32
Array of Model 31
Model 33
Object
status
string
Model 34
Object
level
string
Enumeration:
info
message
string
node_name
string
host
string
port
string
path
string
label
string
timestamp
string
Model 35
Object
file_name
string required
Pattern: ^[^<>:;,?"*|\/]+$
developer_data
Object
developer_account_number
string
developer_name
string
early_payment_process
string
loan_amount_on_credit_contract
string
loan_term_on_credit_contract
string
disbursement_progress
string
beneficiary_information_on_credit_contract
string
penalty_or_interest_on_credit_contract
string
agreement_code
string
Model 36
Object
have_interest_support
boolean
disbursement_amount
string
sales_policy_option_for_interest_support
string
interest_rate_option
string
end_date_for_interest_support
string
exception_end_of_interest_support
string
fixed_interest_period
string
exception_fixed_interest_period
string
available_principal_grace_period
string
exception_available_principal_grace_period
string
fixed_interest_rate
string
exception_fixed_interest_rate
string
margin
string
exception_margin
string
early_repayment_fee
string
exception_early_repayment_fee
string
number_of_repayment
string
annuity_repayment_amount
string
ammortization_repayment_amount
string
remaining_repayment_amount
string
basic_rate
string
need_authorization_letter_for_credit_contract
boolean
monthly_disbursement_date
integer
Min: 1
Max: 31
disbursement_amounts
Array of Model 36
Model 37
Object
contract_period
string
interest_rate_option
string
list_of_interest_rate_option
Array of Model 37
list_of_sales_policy_for_interest_support
Array of string
who_last_edited_this_page
Object
username
string
role
string
Model 38
Object
credit_contract_signing_date
string
contract_period
string required
ltv_for_deposit_aggreement
string
loan_term_for_deposit_aggreement_phase
string
loan_purpose_for_deposit_aggreement_phase
string
actual_loan_limit
string
number_of_disbursement
string
expected_disbursement_date
string
project_code
string
code_number_deposit_or_purchase
string
net
string
vat
string
kpbt
string
developer_data
need_authorization_letter_for_credit_contract
boolean
annuity_repayment_amount
string
disbursement_amounts
temp_saved_max_grace_period_in_month
number
actual_loan_limit_round
string
discount_amount
number
agent_send_investor
boolean
actual_disbursement_date
string
list_of_interest_rate_option
list_of_sales_policy_for_interest_support
who_last_edited_this_page
Model 39
Object
count
string