/Initiate Online Mortgage Short Lead

/Initiate Online Mortgage Short Lead



Request Endpoint

https://test-api.tbcbank.ge/v1/online-mortgages/short-leads
https://api.tbcbank.ge/v1/online-mortgages/short-leads

Authorization

Authorization Type

Description

Bearer Token

access-token should be added to Authorization header

Request Parameters

Parameter

Type

Description

firstName

string

customer's first name

lastName

string

customer's surname

personalNo

string

customer's personal identity number

birthDate

date

customer's birth date in YYYY-MM-DD format

mobileNumber

string

customer's mobile number

url (required)

string

url from which the lead generation was initiated

realEstateCode

string

real estate type code.

The following values are allowed:
FLAT, PRIVATE_HOUSE, COUNTRY_HOUSE, LAND_PLOT, CELLAR, GARAGE, LOFT, COMMERCIAL_ESTATE, OTHER
Details are given on Classification Page

propertyPrice

string

property price.
format: 0.00

propertyPriceCurrencyCode

string

property price currency (3 digit ISO code).
The following values are allowed:
GEL, USD, EUR

termInMonths

number (integer)

loan term in months

monthlyIncome

decimal

customer's monthly income
format: 0.00

isDeveloperOffer

boolean

Is property a developer company offer (true/false)

comment

string (max. length 1200)

additional comment.

Request Sample

{
  "firstName": "გიორგი",
  "lastName": "გიორგაძე",
  "personalNo": "09876543211",
  "birthDate": "1990-05-01",
  "mobileNumber": "555111222",
  "url": "https://ss.ge/ka/udzravi-qoneba/iyideba-kerdzo-saxli-ortatchalashi-3554781",
  "realEstateCode": "FLAT",
  "propertyPrice": 45700,
  "propertyPriceCurrencyCode": "GEL",
  "termInMonths": 180,
  "monthlyIncome": 4500,
  "isDeveloperOffer": true,
  "comment": "DownPayment: 15600$"
}
curl --location --request POST "https://test-api.tbcbank.ge/v1/online-mortgages/short-leads" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer 0070Zep1RzIfIyT0LAq0Hu7VvcaF" \
    --data "{
  \"firstName\": \"გიორგი\",
  \"lastName\": \"გიორგაძე\",
  \"personalNo\": \"09876543211\",
  \"birthDate\": \"1990-05-01\",
  \"mobileNumber\": \"555111222\",
  \"url\": \"https://ss.ge/ka/udzravi-qoneba/iyideba-kerdzo-saxli-ortatchalashi-3554781\",
  \"realEstateCode\": \"FLAT\",
  \"propertyPrice\": 45700,
  \"propertyPriceCurrencyCode\": \"GEL\",
  \"termInMonths\": 180,
  \"monthlyIncome\": 4500,
  \"isDeveloperOffer\": true,
  \"comment\": \"DownPayment: 15600$\"
}
"

Response Parameters

Response Body

response contains unique leadId of the initiated application.

Parameter

Type

Description

leadId

string (guid)

unique identifier of mortgage short-lead

Response Sample

{
    "leadId": "8a8966b2-6782-4d7c-b160-8362481c24fb"
}

Error Response

In case of error, the standard response in problem JSON will be returned.

Details can be found at Error Code Description.

Recipe


Did this page help you?