Skip to main content
POST
/
lending
/
assess
Full credit assessment
curl --request POST \
  --url https://api.txcloud.io/v1/lending/assess \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicant": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "phone": "<string>",
    "email": "<string>",
    "national_id": "<string>"
  },
  "loan_request": {
    "amount": 123,
    "currency": "<string>",
    "term_months": 123,
    "purpose": "<string>"
  },
  "consent": {
    "bureau_check": true,
    "timestamp": "2023-11-07T05:31:56Z",
    "bank_data": true
  },
  "employment": {
    "status": "employed",
    "employer_name": "<string>",
    "monthly_income": 123,
    "income_currency": "<string>"
  },
  "existing_debts": [
    {}
  ]
}
'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "decision": {
    "recommendation": "approve",
    "confidence": 123,
    "max_approved_amount": 123
  },
  "credit_score": {
    "score": 123,
    "grade": "<string>",
    "percentile": 123
  },
  "income_analysis": {},
  "affordability": {},
  "pricing": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
applicant
object
required
loan_request
object
required
employment
object
existing_debts
object[]

Response

200 - application/json

Assessment result

id
string
object
string
status
string
decision
object
credit_score
object
income_analysis
object
affordability
object
pricing
object