RiskBite
Calculate risk based on input data
What kind of data I will get
By using this integration, you will get detailed risk analysis information about checked customer.
Input data definition
The input data for integration may have a wide range of reports on the basis of which the risk assessment is built.
In addition to reports, it is also possible to provide basic information collected from the client.
List of report which could be used in input:
- AIS
- BIK consumer
- BIK entrepreneur
- BIG InfoMonitor consumer
- BIG InfoMonitor entrepreneur
- KRD consumer
- KRD non consumer
- PWG
- ERIF
- CEIDG
- CRIF
Output data
In response, you will receive detailed information on the risk assessment, along with calculated financial offers and detailed information on the risks.
{
"riskbite" : {
"version" : "RBox, Version=1.7.0.5, Culture=neutral, PublicKeyToken=null",
"request" : {
"userId" : "SomeUser",
"productType" : "RiskReportBusiness",
"applicationId" : "72f406fa-332f-4150-8347-d8700ca6d49f",
"timestamp" : "2022-06-20",
"test" : false,
"applicationForm" : {
"nationality" : "PL",
"requestedAmount" : 2400,
"requestedTenor" : 6,
"nip" : "5252278252",
"income" : 10918.4167
},
"internalPerformance" : {
"isAlreadyClient" : false,
"histCount" : 0,
"isActive" : false,
"maxInstallmentMultiplier" : 6,
"screenScrapeType" : "TransactionLink",
"nativeCurrency" : "PLN"
},
"dataToSkip" : {
"screenScrape" : false,
"blueCash" : true,
"erif" : true,
"krd" : true,
"infoMonitor" : false,
"bikKi" : true,
"crif" : true,
"bikP" : true,
"ceidg" : true
}
},
"requestTime" : "2022-06-20",
"responseTime" : "2022-06-20",
"grantedProductType" : "RiskReportBusiness",
"decision" : {
"code" : 39300,
"reason" : "Accept",
"report" : "Final",
"descriptionReason" : "Criteria met",
"descriptionClient" : "Criteria met"
},
"decisions" : {
"Initial" : {
"code" : 2,
"reason" : "SoFarSoGood",
"report" : "Initial",
"descriptionReason" : "So far so good"
},
"ScreenScrape" : {
"code" : 23302,
"reason" : "SoFarSoGood",
"report" : "ScreenScrape",
"descriptionReason" : "So far so good"
},
"Infomonitor" : {
"code" : 25302,
"reason" : "SoFarSoGood",
"report" : "Infomonitor",
"descriptionReason" : "So far so good"
},
"Flags" : {
"code" : 2,
"reason" : "SoFarSoGood",
"report" : "Flags",
"descriptionReason" : "So far so good"
},
"Final" : {
"code" : 39300,
"reason" : "Accept",
"report" : "Final",
"descriptionReason" : "Criteria met",
"descriptionClient" : "Criteria met"
}
},
"flags" : [ {
"code" : "FZ02",
"type" : "Performance",
"messageAnalyst" : "Wysokość przychodu: 10325.46",
"messageClient" : "Wysokość przychodu",
"report" : "ScreenScrape"
} ],
"offer" : {
"Best" : {
"chance" : 3,
"grossAmount" : 5000.0,
"netAmount" : 5000.0,
"tenor" : 12,
"installmentAmount" : 416.6667,
"amountToPay" : 5000.0
},
"Unlimited" : {
"grossAmount" : 62000.0,
"netAmount" : 62000.0,
"tenor" : 12,
"installmentAmount" : 5162.7308,
"amountToPay" : 61952.7692
},
"RequestedTenor" : {
"grossAmount" : 3000.0,
"netAmount" : 2500.0,
"tenor" : 6,
"installmentAmount" : 416.6667,
"amountToPay" : 2500.0
},
"Requested" : {
"grossAmount" : 2000.0,
"netAmount" : 2400.0,
"tenor" : 6,
"installmentAmount" : 400.0,
"amountToPay" : 2400.0
}
},
"grantedAmount" : 2400,
"grantedTenor" : 6,
"grantedAmountMax" : 5000,
"grantedTenorMax" : 12,
"maximumInstallmentAmount" : 5162.7308,
"clientAge" : 0,
"dti" : -0.0,
"riskGroup" : "A1",
"otherBureaus" : {
"infomonitorData" : {
"installmentLoans" : { },
"revolvingLoans" : { },
"hasFatal" : false,
"positiveAmount" : 0.0,
"positiveCount" : 0,
"negativeAmount" : 0.0,
"negativeCount" : 0,
"negativeLiabilities" : [ ]
}
},
"screenScrape" : {
"type" : "TransactionLink",
"names" : [ ],
"pesel" : [ ],
"oldestActivity" : "2021-06-24",
"oldestActivityMonths" : 12,
"activeSinceAtLeast" : "2022-06-20",
"activeSinceAtLeastMonths" : 0,
"bankAccountNumbers" : [ "PL62114020040000310277251776" ],
"contractors" : [ {
"iban" : "PL33114046171575434056534474",
"name" : "Henryk Pietrzak",
"count" : [ 5, 4, 0, 2, 0, 1, 0, 0, 1, 0, 1, 1, 0 ],
"amount" : [ 12680.0, 11851.0, 0.0, 5072.0, 0.0, 2536.0, 0.0, 0.0, 2536.0, 0.0, 2536.0, 2536.0, 0.0 ],
"totalAmount" : 39747.0,
"totalCount" : 15,
"average" : 2649.8
}, {
"iban" : "PL13105081707304614358790477",
"name" : "Allan Jankowski",
"count" : [ 2, 1, 0, 3, 3, 1, 1, 4, 1, 1, 4, 1, 0 ],
"amount" : [ 1116.0, 558.0, 0.0, 1674.0, 1674.0, 558.0, 558.0, 2232.0, 558.0, 558.0, 2232.0, 558.0, 0.0 ],
"totalAmount" : 12276.0,
"totalCount" : 22,
"average" : 558.0
}, {
"iban" : "PL23116022600319418058981335",
"name" : "Sklep Alexander",
"count" : [ 0, 0, 1, 0, 0, 0, 2, 1, 0, 0, 0, 0, 0 ],
"amount" : [ 0.0, 0.0, 7795.0, 0.0, 0.0, 0.0, 15590.0, 7795.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"totalAmount" : 31180.0,
"totalCount" : 4,
"average" : 7795.0
}, {
"iban" : "PL30114078781754345842109842",
"name" : "Remigiusz Kowalski",
"count" : [ 1, 1, 2, 1, 1, 1, 2, 2, 1, 0, 1, 3, 1 ],
"amount" : [ 3210.0, 3210.0, 4649.0, 3210.0, 3210.0, 3210.0, 6420.0, 4649.0, 3210.0, 0.0, 3210.0, 9630.0, 3210.0 ],
"totalAmount" : 51028.0,
"totalCount" : 17,
"average" : 3001.6471
} ],
"uniqueContractors" : 4,
"factoringAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"factoringN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"invoicesAmt" : [ 3210.0, 3210.0, 12444.0, 3210.0, 3210.0, 3210.0, 22010.0, 12444.0, 3210.0, 0.0, 3210.0, 9630.0, 3210.0 ],
"invoicesN" : [ 1, 1, 3, 1, 1, 1, 4, 3, 1, 0, 1, 3, 1 ],
"colAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"disbAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"extAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"gamblingAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"incomeAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"inflow" : [ 17006.0, 15619.0, 12444.0, 9956.0, 4884.0, 6304.0, 22568.0, 14676.0, 6304.0, 558.0, 7978.0, 12724.0, 3210.0 ],
"inflowClearedAmt" : [ 17006.0, 15619.0, 12444.0, 9956.0, 4884.0, 6304.0, 22568.0, 14676.0, 6304.0, 558.0, 7978.0, 12724.0, 3210.0 ],
"inflowClearedN" : [ 8, 6, 3, 6, 4, 3, 5, 7, 3, 1, 6, 5, 1 ],
"outflow" : [ -5717.0, -212.0, -318.0, -7317.0, -3976.0, -4939.0, -318.0, -6407.0, -212.0, -318.0, -10656.0, -212.0, -106.0 ],
"pmtAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"debtAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"debtN" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"socialAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"taxAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"newAccounts" : 0,
"colN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"disbN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"extN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"alimonyAmt" : [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ],
"alimonyN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"gamblingN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"incomeN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"pmtN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"socialN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"taxN" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"verif" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
"averageInflowCleared" : 10325.4615,
"averageCollectionAmount" : 0.0
},
"progress" : {
"imIsOk" : true,
"screenScrapeIsOk" : true
}
}
}
Output data model structure
A detailed description of the response structure using the swagger standard.
openapi: 3.0.1
info:
title: RBox v1.7.0.5
version: v1
paths:
'/engine/{userId}':
post:
tags:
- Engine
parameters:
- name: userId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EngineJsonRequest'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EngineResponse'
/engine:
post:
tags:
- Engine
parameters:
- name: userId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EngineJsonRequest'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EngineResponse'
components:
schemas:
accountStatusEnum:
enum:
- open
- closed
- vindication
- execution
- recovered
- writtenOff
type: string
ApplicationForm:
type: object
properties:
firstName:
type: string
nullable: true
lastName:
type: string
nullable: true
bankAccountNumber:
type: string
nullable: true
pesel:
maxLength: 11
minLength: 11
type: string
nullable: true
documentId:
maxLength: 9
minLength: 9
type: string
nullable: true
birthDate:
type: string
format: date-time
nullable: true
gender:
type: string
nullable: true
nationality:
type: string
nullable: true
requestedAmount:
type: integer
format: int32
requestedTenor:
type: integer
format: int32
applicationSource:
type: string
nullable: true
incomeSource:
type: string
nullable: true
nip:
type: string
nullable: true
job:
type: string
nullable: true
employmentSector:
type: string
nullable: true
purpose:
type: string
nullable: true
salaryDay:
type: integer
format: int32
nullable: true
jobExperienceYears:
type: integer
format: int32
nullable: true
jobExperienceMonths:
type: integer
format: int32
nullable: true
income:
type: number
format: double
nullable: true
declaredIncome:
type: number
format: double
nullable: true
readOnly: true
incomeHousehold:
type: number
format: double
nullable: true
installmentAmount:
type: number
format: double
nullable: true
limitAmount:
type: number
format: double
nullable: true
expenses:
type: number
format: double
nullable: true
householdSize:
type: integer
format: int32
nullable: true
maritalStatus:
type: string
nullable: true
education:
type: string
nullable: true
housingStatus:
type: string
nullable: true
housingYears:
type: integer
format: int32
nullable: true
housingMonths:
type: integer
format: int32
nullable: true
hasCar:
type: boolean
nullable: true
carYear:
type: integer
format: int32
nullable: true
carValue:
type: number
format: double
nullable: true
overdueAmountSocial:
type: number
format: double
nullable: true
overdueAmountTax:
type: number
format: double
nullable: true
companyTaxForm:
type: string
nullable: true
companyLegalForm:
type: string
nullable: true
companyLegalFormId:
type: integer
format: int32
nullable: true
dpdTax:
type: integer
format: int32
nullable: true
dpdSocial:
type: integer
format: int32
nullable: true
paymentPlanTax:
type: boolean
nullable: true
paymentPlanSocial:
type: boolean
nullable: true
commissions:
type: object
additionalProperties:
$ref: '#/components/schemas/Commission'
nullable: true
invoicePaymentPeriod:
type: integer
format: int32
nullable: true
additionalProperties: false
BikData:
type: object
properties:
relationStart:
type: string
format: date-time
relationLength:
type: integer
format: int32
timestamp:
type: string
format: date-time
inquiries:
type: array
items:
type: integer
format: int32
nullable: true
recentInquiries:
type: integer
format: int32
pastInquiries:
type: integer
format: int32
debtBurden:
$ref: '#/components/schemas/BikDebtBurden'
worstCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
obligations:
type: array
items:
$ref: '#/components/schemas/BikObligation'
nullable: true
maxHistoricalDpd:
type: integer
format: int32
nullable: true
readOnly: true
maxCurrentDpd:
type: integer
format: int32
nullable: true
readOnly: true
additionalProperties: false
BikDebtBurden:
type: object
properties:
currentDebt:
type: number
format: double
readOnly: true
currentBankDebt:
type: number
format: double
currentNonBankDebt:
type: number
format: double
openLoans:
type: integer
format: int32
readOnly: true
openBankLoans:
type: integer
format: int32
openNonBankLoans:
type: integer
format: int32
additionalProperties: false
BikKiData:
type: object
properties:
consumerBankruptcyStatus:
$ref: '#/components/schemas/consumerBankruptcyStatusEnum'
peselInconsistentlyAssigned:
type: boolean
mainDocumentInconsistentlyAssigned:
type: boolean
secondDocumentInconsistentlyAssigned:
type: boolean
worstHistorical:
$ref: '#/components/schemas/PaymentStatusEnum'
bankBorrowerCreditCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankBorrowerCreditMax:
$ref: '#/components/schemas/PaymentStatusEnum'
bankBorrowerLimitCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankBorrowerLimitMax:
$ref: '#/components/schemas/PaymentStatusEnum'
bankBorrowerOtherCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankGuaranterCreditCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankGuaranterCreditMax:
$ref: '#/components/schemas/PaymentStatusEnum'
bankGuaranterLimitCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankGuaranterLimitMax:
$ref: '#/components/schemas/PaymentStatusEnum'
bankGuaranterOtherCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankCollateralCreditCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankCollateralCreditMax:
$ref: '#/components/schemas/PaymentStatusEnum'
bankCollateralLimitCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
bankCollateralLimitMax:
$ref: '#/components/schemas/PaymentStatusEnum'
bankCollateralOtherCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankBorrowerCreditCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankBorrowerCreditMax:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankBorrowerLimitCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankBorrowerLimitMax:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankBorrowerOtherCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankGuaranterCreditCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankGuaranterCreditMax:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankGuaranterLimitCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankGuaranterLimitMax:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankGuaranterOtherCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankCollateralCreditCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankCollateralCreditMax:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankCollateralLimitCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankCollateralLimitMax:
$ref: '#/components/schemas/PaymentStatusEnum'
nonBankCollateralOtherCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
scoreSegment:
$ref: '#/components/schemas/BikScoreSegment'
relationStart:
type: string
format: date-time
relationLength:
type: integer
format: int32
timestamp:
type: string
format: date-time
inquiries:
type: array
items:
type: integer
format: int32
nullable: true
recentInquiries:
type: integer
format: int32
pastInquiries:
type: integer
format: int32
debtBurden:
$ref: '#/components/schemas/BikDebtBurden'
worstCurrent:
$ref: '#/components/schemas/PaymentStatusEnum'
obligations:
type: array
items:
$ref: '#/components/schemas/BikObligation'
nullable: true
maxHistoricalDpd:
type: integer
format: int32
nullable: true
readOnly: true
maxCurrentDpd:
type: integer
format: int32
nullable: true
readOnly: true
additionalProperties: false
BikObligation:
type: object
properties:
businessType:
$ref: '#/components/schemas/BusinessTypeEnum'
productType:
type: string
nullable: true
ownDataMarker:
type: boolean
recordID:
type: string
nullable: true
subscriberUnitName:
type: string
nullable: true
subscriberUnitId:
type: string
nullable: true
clientRelation:
$ref: '#/components/schemas/ClientRelationEnum'
relationBeginningDate:
type: string
format: date-time
nullable: true
relationTerminationDate:
type: string
format: date-time
nullable: true
paymentStatusAtAccession:
type: string
nullable: true
agreementConclusionDate:
type: string
format: date-time
closeDate:
type: string
format: date-time
nullable: true
balanceDate:
type: string
format: date-time
creditCollateralStatus:
$ref: '#/components/schemas/CreditCollateralStatusEnum'
status:
$ref: '#/components/schemas/accountStatusEnum'
economicFinancialStatus:
$ref: '#/components/schemas/economicFinancialStatusEnum'
creditAmountWithInterest:
type: number
format: double
creditAmount:
type: number
format: double
installmentAmount:
type: integer
format: int32
creditLimit:
type: number
format: double
exchangeRate:
type: number
format: double
numberOfParticipants:
type: integer
format: int32
expectedRepaymentDate:
type: string
format: date-time
nullable: true
worstPaymentStatus:
$ref: '#/components/schemas/PaymentStatusEnum'
worstRecentDpd:
type: integer
format: int32
nullable: true
lastUpdate:
type: string
format: date-time
nullable: true
currencyCode:
$ref: '#/components/schemas/CurrencyEnum'
currentPaymentStatus:
$ref: '#/components/schemas/PaymentStatusEnum'
currentDPD:
type: integer
format: int32
nullable: true
maxDPD:
type: integer
format: int32
currentBalance:
type: integer
format: int32
currentDueAmount:
type: integer
format: int32
nullable: true
debt:
type: number
format: double
additionalProperties: false
BikScoreSegment:
type: object
properties:
responseId:
type: string
nullable: true
supResult:
$ref: '#/components/schemas/successProcessingEnum'
result:
$ref: '#/components/schemas/cr3ResultEnum'
score:
type: integer
format: int32
nullable: true
pd:
type: number
format: double
odds:
type: number
format: double
message:
type: string
nullable: true
segment:
type: integer
format: int32
nullable: true
additionalProperties: false
BusinessTypeEnum:
enum:
- unknown
- bank
- bankDerivedLoanCompany
- buildingSociety
- businessCreditor
- creditCardIssuer
- creditInstitution
- creditIntermediary
- creditUnion
- debtCollectionBureau
- debtCollectionCompany
- economicInformationBureau
- EIB
- factoring
- financialInstitution
- guaranteeFund
- insuranceCompany
- leasingCompany
- loanCompany
- mailOrderSale
- onLineServices
- other
- powerIndustry
- realEstateInvestingCompany
- retailer
- securitiesInvestingCompany
- securitiesRevolvingCompany
- telecomCompany
- tvNetworkRental
type: string
Category:
type: object
properties:
code:
$ref: '#/components/schemas/CategoryCodeEnum'
output:
type: string
nullable: true
report:
$ref: '#/components/schemas/ReportEnum'
additionalProperties: false
CategoryCodeEnum:
enum:
- None
- S01
- S00
- S14
- S13
- S12
- S11
- S10
- S24
- S23
- S22
- S21
- S20
- S32
- S31
- S30
- S41
- S54
- S53
- S52
- S51
- S50
- S62
- S61
- S60
- S71
- S81
- S80
- S91
- S90
- SA1
- SA0
- SB1
- SB0
- SC1
- SC0
- SD5
- SD4
- SD3
- SD2
- SD1
- SD0
- SE2
- SE1
- SE0
- SF2
- SF1
- SG1
- SG0
- SH1
- SH0
type: string
CeidgData:
type: object
properties:
firstName:
type: string
nullable: true
lastName:
type: string
nullable: true
nip:
type: string
nullable: true
regon:
type: string
nullable: true
companyName:
type: string
nullable: true
country:
type: string
nullable: true
postCode:
type: string
nullable: true
startDate:
type: string
format: date-time
pauseDate:
type: string
format: date-time
nullable: true
resumeDate:
type: string
format: date-time
nullable: true
endDate:
type: string
format: date-time
nullable: true
isMaritalShare:
type: boolean
status:
type: string
nullable: true
pkdCodes:
type: array
items:
type: string
nullable: true
readOnly: true
isBankrupcyInformation:
type: boolean
readOnly: true
additionalProperties: false
ClientRelationEnum:
enum:
- authorizedUser
- coBorrower
- guarantor
- joiningCoBorrower
- mainBorrower
- providerOfCollateral
type: string
Commission:
type: object
properties:
tenor:
type: integer
format: int32
initialCommissionRate:
type: number
format: double
yearlyCommissionRate:
type: number
format: double
yearlyInterestRate:
type: number
format: double
additionalProperties: false
CompanyDebt:
type: object
properties:
amount:
type: string
nullable: true
readOnly: true
source:
type: string
nullable: true
readOnly: true
rawValue:
type: string
nullable: true
readOnly: true
additionalProperties: false
consumerBankruptcyStatusEnum:
enum:
- lackOfInfo
- submissionApplication
- dismissalApplication
- bankruptcyDeclaration
- bankruptcyCompletion
- bankruptcyDiscontinuance
type: string
ContractorData:
type: object
properties:
iban:
type: string
nullable: true
name:
type: string
nullable: true
count:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
amount:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
totalAmount:
type: number
format: double
readOnly: true
totalCount:
type: integer
format: int32
average:
type: number
format: double
readOnly: true
additionalProperties: false
cr3ResultEnum:
enum:
- scoreCalculated
- hasAccountUR
- hasAccountT1
- hasAccountT2
- hasAccountT3
- hasAccountT4
- hasAccountT5
- hasAccountT6
- hasAccountT7
- hasAccountT8
- notMainAccount
- consumerBankruptcy
- lackOfInfo
- datatypeNotSupported
- systemError
type: string
CreditCollateralStatusEnum:
enum:
- unknown
- collateral
- noInfo
- organizationSecured
- other
- otherPersonSecured
- purchasedGoodsSecured
- secured
- unsecured
type: string
CrifData:
type: object
properties:
flag:
$ref: '#/components/schemas/TrafficLight'
clientExtensions:
type: object
additionalProperties:
type: string
nullable: true
additionalProperties: false
CurrencyEnum:
enum:
- ATS
- AUD
- BEF
- CAD
- CHF
- CZK
- DEM
- DKK
- EEK
- ESP
- EUR
- FIM
- FRF
- GBP
- GRD
- HKD
- HUF
- IEP
- ITL
- JPY
- LTL
- LUF
- LVL
- NLG
- NOK
- PLN
- PTE
- RUB
- SEK
- USD
- ZAR
type: string
Decision:
type: object
properties:
code:
type: integer
format: int32
readOnly: true
reason:
$ref: '#/components/schemas/ReasonEnum'
report:
$ref: '#/components/schemas/ReportEnum'
descriptionReason:
type: string
nullable: true
readOnly: true
descriptionClient:
type: string
nullable: true
readOnly: true
additionalProperties: false
economicFinancialStatusEnum:
enum:
- normal
- underObservation
- belowAverage
- doubtful
- lost
type: string
EngineJsonRequest:
required:
- request
type: object
properties:
request:
$ref: '#/components/schemas/EngineRequest'
bikKi:
type: string
format: byte
nullable: true
bikP:
type: string
format: byte
nullable: true
pwg:
type: string
format: byte
nullable: true
krd:
type: array
items:
type: string
format: byte
nullable: true
screenScrape:
type: array
items:
type: string
format: byte
nullable: true
infomonitor:
type: array
items:
type: string
format: byte
nullable: true
erif:
type: array
items:
type: string
format: byte
nullable: true
ceidg:
type: array
items:
type: string
format: byte
nullable: true
crif:
type: string
format: byte
nullable: true
additionalProperties: false
EngineProductType:
enum:
- None
- PayDay
- InstallmentPersonal
- InstallmentBusiness
- BridgingBusiness
- RiskReportBusiness
type: string
EngineRequest:
required:
- applicationId
- productType
- userId
type: object
properties:
userId:
type: string
productType:
$ref: '#/components/schemas/EngineProductType'
applicationId:
type: string
requestId:
type: string
nullable: true
timestamp:
type: string
format: date-time
test:
type: boolean
applicationForm:
$ref: '#/components/schemas/ApplicationForm'
internalPerformance:
$ref: '#/components/schemas/InternalPerformance'
dataToSkip:
$ref: '#/components/schemas/OmitData'
potentialOffers:
type: object
additionalProperties:
$ref: '#/components/schemas/PotentialOffer'
nullable: true
additionalProperties: false
EngineResponse:
type: object
properties:
version:
type: string
nullable: true
readOnly: true
request:
$ref: '#/components/schemas/EngineRequest'
requestTime:
type: string
format: date-time
responseTime:
type: string
format: date-time
grantedProductType:
$ref: '#/components/schemas/EngineProductType'
decision:
$ref: '#/components/schemas/Decision'
decisions:
type: object
properties:
Initial:
$ref: '#/components/schemas/Decision'
ScreenScrape:
$ref: '#/components/schemas/Decision'
Crif:
$ref: '#/components/schemas/Decision'
ModelScore:
$ref: '#/components/schemas/Decision'
Infomonitor:
$ref: '#/components/schemas/Decision'
Erif:
$ref: '#/components/schemas/Decision'
Krd:
$ref: '#/components/schemas/Decision'
BikKi:
$ref: '#/components/schemas/Decision'
BikP:
$ref: '#/components/schemas/Decision'
Flags:
$ref: '#/components/schemas/Decision'
Ceidg:
$ref: '#/components/schemas/Decision'
Pwg:
$ref: '#/components/schemas/Decision'
Final:
$ref: '#/components/schemas/Decision'
additionalProperties: false
nullable: true
masterDecision:
$ref: '#/components/schemas/Decision'
flags:
type: array
items:
$ref: '#/components/schemas/Flag'
nullable: true
summary:
type: array
items:
$ref: '#/components/schemas/SummaryItem'
nullable: true
categories:
type: array
items:
$ref: '#/components/schemas/Category'
nullable: true
potentialOffers:
type: array
items:
$ref: '#/components/schemas/PotentialOfferResponse'
nullable: true
offer:
type: object
properties:
Best:
$ref: '#/components/schemas/Offer'
Unlimited:
$ref: '#/components/schemas/Offer'
RequestedTenor:
$ref: '#/components/schemas/Offer'
Requested:
$ref: '#/components/schemas/Offer'
additionalProperties: false
nullable: true
rating:
type: integer
format: int32
grantedAmount:
type: integer
format: int32
grantedTenor:
type: integer
format: int32
grantedAmountMax:
type: integer
format: int32
grantedTenorMax:
type: integer
format: int32
readOnly: true
maximumInstallmentAmount:
type: number
format: double
readOnly: true
clientAge:
type: integer
format: int32
dti:
type: number
format: double
decisionScore:
nullable: true
bikKiData:
$ref: '#/components/schemas/BikKiData'
riskGroup:
type: string
nullable: true
bikPData:
$ref: '#/components/schemas/BikData'
crifData:
$ref: '#/components/schemas/CrifData'
otherBureaus:
$ref: '#/components/schemas/OtherBureas'
screenScrape:
$ref: '#/components/schemas/ScreenScrape'
ceidgData:
$ref: '#/components/schemas/CeidgData'
pwgData:
$ref: '#/components/schemas/PwgData'
progress:
$ref: '#/components/schemas/Progress'
additionalProperties: false
Flag:
type: object
properties:
code:
$ref: '#/components/schemas/FlagCodeEnum'
type:
$ref: '#/components/schemas/FlagTypeEnum'
messageAnalyst:
type: string
nullable: true
messageClient:
type: string
nullable: true
report:
$ref: '#/components/schemas/ReportEnum'
additionalProperties: false
FlagCodeEnum:
enum:
- None
- FN01
- FN02
- FN03
- FN04
- FN05
- FN06
- FN07
- FN08
- FF02
- FF03
- FF04
- FF05
- FF06
- FF07
- FF08
- FZ01
- FZ02
- FZ03
- FZ04
- FZ05
- FZ06
- FZ07
type: string
FlagTypeEnum:
enum:
- None
- Reject
- Formal
- Performance
type: string
HistoryItem:
type: object
properties:
userId:
type: string
nullable: true
loanId:
type: string
nullable: true
requestDate:
type: string
format: date-time
grantedDate:
type: string
format: date-time
nullable: true
repaidDate:
type: string
format: date-time
nullable: true
maturityDate:
type: string
format: date-time
nullable: true
loanAmount:
type: number
format: double
dpd:
type: integer
format: int32
nullable: true
tenor:
type: integer
format: int32
additionalProperties: false
InfomonitorData:
type: object
properties:
bikScoreMessage:
type: string
nullable: true
readOnly: true
bikScore:
type: integer
format: int32
nullable: true
readOnly: true
installmentLoans:
$ref: '#/components/schemas/InstallmentLoanInformation'
revolvingLoans:
$ref: '#/components/schemas/RevolvingLoanInformation'
paymentHistory:
type: array
items:
$ref: '#/components/schemas/TypWektorStatusuPlatnosci'
nullable: true
readOnly: true
hasFatal:
type: boolean
positiveAmount:
type: number
format: double
positiveCount:
type: integer
format: int32
negativeAmount:
type: number
format: double
negativeCount:
type: integer
format: int32
negativeLiabilities:
type: array
items:
$ref: '#/components/schemas/OtherBureauLiability'
nullable: true
readOnly: true
additionalProperties: false
InstallmentLoanInformation:
type: object
properties:
numberOfAccounts:
type: integer
format: int32
nullable: true
readOnly: true
installmentAmount:
type: number
format: double
nullable: true
readOnly: true
currentDueAmount:
type: number
format: double
nullable: true
readOnly: true
outstandingBalance:
type: number
format: double
nullable: true
readOnly: true
additionalProperties: false
InternalPerformance:
type: object
properties:
firstLoanDate:
type: string
format: date-time
nullable: true
lastApplication:
type: string
format: date-time
nullable: true
lastApplicationStatus:
type: string
nullable: true
isAlreadyClient:
type: boolean
maxDPD:
type: integer
format: int32
nullable: true
prevMaxDPD:
type: integer
format: int32
nullable: true
histCount:
type: integer
format: int32
history:
type: array
items:
$ref: '#/components/schemas/HistoryItem'
nullable: true
prevAmount:
type: integer
format: int32
nullable: true
productMaximum:
type: integer
format: int32
nullable: true
isActive:
type: boolean
hasRecentBikKi:
type: boolean
nullable: true
hasRecentBikP:
type: boolean
nullable: true
maxInstallmentMultiplier:
type: integer
format: int32
screenScrapeType:
$ref: '#/components/schemas/ScreenScrapeType'
nativeCurrency:
type: string
nullable: true
exchangeRates:
type: object
additionalProperties:
type: number
format: double
nullable: true
additionalProperties: false
Offer:
type: object
properties:
chance:
type: integer
format: int32
nullable: true
grossAmount:
type: number
format: double
readOnly: true
netAmount:
type: number
format: double
readOnly: true
tenor:
type: integer
format: int32
installmentAmount:
type: number
format: double
amountToPay:
type: number
format: double
readOnly: true
additionalProperties: false
OmitData:
type: object
properties:
screenScrape:
type: boolean
blueCash:
type: boolean
erif:
type: boolean
krd:
type: boolean
infoMonitor:
type: boolean
bikKi:
type: boolean
crif:
type: boolean
bikP:
type: boolean
ceidg:
type: boolean
additionalProperties: false
OtherBureas:
type: object
properties:
krdData:
$ref: '#/components/schemas/OtherBureauData'
infomonitorData:
$ref: '#/components/schemas/InfomonitorData'
erifAmount:
type: number
format: double
nullable: true
readOnly: true
erifNumber:
type: integer
format: int32
nullable: true
readOnly: true
additionalProperties: false
OtherBureauData:
type: object
properties:
hasFatal:
type: boolean
positiveAmount:
type: number
format: double
positiveCount:
type: integer
format: int32
negativeAmount:
type: number
format: double
negativeCount:
type: integer
format: int32
negativeLiabilities:
type: array
items:
$ref: '#/components/schemas/OtherBureauLiability'
nullable: true
readOnly: true
additionalProperties: false
OtherBureauLiability:
type: object
properties:
dataSource:
type: string
nullable: true
readOnly: true
productType:
type: string
nullable: true
entryDate:
type: string
format: date-time
nullable: true
amount:
type: number
format: double
nullable: true
lenderName:
type: string
nullable: true
additionalProperties: false
PaymentStatusEnum:
enum:
- noValue
- pastDueBelow30Days
- pastDueBelowMonth
- pastDueBelow90Days
- pastDueBelow3Months
- pastDueBelow180Days
- pastDueBelow6Months
- pastDueOver180Days
- pastDueBelowYear
- pastDueOverYear
- recovered
- writtenOff
- debtCollection
- execution
type: string
PeopleInvolvedActivity:
type: object
properties:
id:
type: integer
format: int32
person:
type: string
nullable: true
position:
type: string
nullable: true
activity:
type: string
nullable: true
company:
type: string
nullable: true
isNegative:
type: boolean
isHistoric:
type: boolean
additionalProperties: false
PotentialOffer:
type: object
properties:
monthlyIncome:
type: number
format: double
nullable: true
minInflowMonths:
type: integer
format: int32
nullable: true
maxDTI:
type: number
format: double
nullable: true
invoicePaymentPeriodMin:
type: integer
format: int32
nullable: true
invoicePaymentPeriodMax:
type: integer
format: int32
nullable: true
nationality:
type: array
items:
type: string
nullable: true
clientAgeMin:
type: integer
format: int32
nullable: true
clientAgeMinNoScore:
type: integer
format: int32
nullable: true
clientAgeMax:
type: integer
format: int32
nullable: true
minActivityLength:
type: integer
format: int32
nullable: true
minActivityLengthNoScore:
type: integer
format: int32
nullable: true
companyBankruptcyStatus:
type: boolean
nullable: true
companySuspensions:
$ref: '#/components/schemas/WeightedPeriod'
companyCountry:
type: array
items:
type: string
nullable: true
companyLegalForms:
type: array
items:
type: string
nullable: true
companyExcludedTaxForms:
type: array
items:
type: string
nullable: true
companyExcludedSectors:
type: array
items:
type: string
nullable: true
companyAcceptedStatuses:
type: array
items:
type: string
nullable: true
hitBR:
type: boolean
nullable: true
hitDZ:
type: boolean
nullable: true
consumerBankruptcyStatus:
type: boolean
nullable: true
bikMinHistoryLength:
type: integer
format: int32
nullable: true
bikMaxCurrentDPD:
type: integer
format: int32
nullable: true
bikMaxHistDPD:
$ref: '#/components/schemas/WeightedPeriod'
bikKiExcludedStatuses:
type: array
items:
$ref: '#/components/schemas/PaymentStatusEnum'
nullable: true
bikKiExcludedKku:
type: array
items:
type: string
nullable: true
bikPExcludedStatuses:
type: array
items:
$ref: '#/components/schemas/PaymentStatusEnum'
nullable: true
bikKiCutoffScore:
type: number
format: double
nullable: true
bikKiMaxPSN:
type: integer
format: int32
nullable: true
bikPMaxPSN:
type: integer
format: int32
nullable: true
bikKiMaxInq:
$ref: '#/components/schemas/WeightedPeriod'
bikPMaxInq:
$ref: '#/components/schemas/WeightedPeriod'
bikKiMinMaxActive:
type: array
items:
type: integer
format: int32
nullable: true
bikKiMinMaxActiveMortgage:
type: array
items:
type: integer
format: int32
nullable: true
bikKiMinMaxDebt:
type: array
items:
type: integer
format: int32
nullable: true
bikKiMaxLimitUtil:
type: number
format: double
nullable: true
krdAmount:
type: number
format: double
nullable: true
imAmount:
type: number
format: double
nullable: true
socialDpd:
type: integer
format: int32
nullable: true
socialMinPayment:
$ref: '#/components/schemas/WeightedPeriod'
taxDpd:
type: integer
format: int32
nullable: true
taxMinPayment:
$ref: '#/components/schemas/WeightedPeriod'
alimonyAmount:
$ref: '#/components/schemas/WeightedPeriod'
collectionsAmount:
$ref: '#/components/schemas/WeightedPeriod'
afCheck:
type: boolean
nullable: true
active:
type: boolean
productCategory:
type: string
nullable: true
lender:
type: string
nullable: true
productType:
type: string
nullable: true
iconUrl:
type: string
nullable: true
productLink:
type: string
nullable: true
productId:
type: string
nullable: true
additionalProperties: false
PotentialOfferResponse:
type: object
properties:
productCategory:
type: string
nullable: true
lender:
type: string
nullable: true
productType:
type: string
nullable: true
iconUrl:
type: string
nullable: true
productLink:
type: string
nullable: true
productId:
type: string
nullable: true
additionalProperties: false
Progress:
type: object
properties:
krdIsOk:
type: boolean
nullable: true
erifIsOk:
type: boolean
nullable: true
imIsOk:
type: boolean
nullable: true
bikKiIsOk:
type: boolean
nullable: true
bikPIsOk:
type: boolean
nullable: true
screenScrapeIsOk:
type: boolean
nullable: true
crifIsOk:
type: boolean
nullable: true
ceidgIsOk:
type: boolean
nullable: true
pwgIsOk:
type: boolean
nullable: true
additionalProperties: false
PwgData:
type: object
properties:
peopleInvolvedActivities:
type: array
items:
$ref: '#/components/schemas/PeopleInvolvedActivity'
nullable: true
debtsList:
type: array
items:
$ref: '#/components/schemas/CompanyDebt'
nullable: true
companyDebts:
type: array
items:
$ref: '#/components/schemas/CompanyDebt'
nullable: true
vatAccountNumbers:
type: array
items:
type: string
nullable: true
readOnly: true
registeredCompanyName:
type: string
nullable: true
readOnly: true
mainPkdCode:
type: string
nullable: true
readOnly: true
currentCourtDecision:
type: string
nullable: true
readOnly: true
registeredDate:
type: string
format: date-time
nullable: true
readOnly: true
vatRegistrationDate:
type: string
format: date-time
nullable: true
readOnly: true
additionalProperties: false
ReasonEnum:
enum:
- None
- Reject
- Error
- Mismatch
- SoFarSoGood
- Manual
- Accept
type: string
Recommendation:
type: object
properties:
title:
type: string
nullable: true
body:
type: string
nullable: true
additionalProperties: false
ReportEnum:
enum:
- Initial
- ScreenScrape
- Crif
- ModelScore
- Infomonitor
- Erif
- Krd
- BikKi
- BikP
- Flags
- Ceidg
- Pwg
- Final
type: string
RevolvingLoanInformation:
type: object
properties:
numberOfAccounts:
type: integer
format: int32
nullable: true
readOnly: true
creditLimit:
type: number
format: double
nullable: true
readOnly: true
currentDueAmount:
type: number
format: double
nullable: true
readOnly: true
additionalProperties: false
ScreenScrape:
type: object
properties:
reportDate:
type: string
format: date-time
nullable: true
type:
$ref: '#/components/schemas/ScreenScrapeType'
names:
uniqueItems: true
type: array
items:
type: string
nullable: true
pesel:
uniqueItems: true
type: array
items:
type: string
nullable: true
birthDate:
type: string
format: date-time
nullable: true
oldestActivity:
type: string
format: date-time
nullable: true
oldestActivityMonths:
type: integer
format: int32
nullable: true
activeSinceAtLeast:
type: string
format: date-time
nullable: true
activeSinceAtLeastMonths:
type: integer
format: int32
nullable: true
bankAccountNumbers:
uniqueItems: true
type: array
items:
type: string
nullable: true
incomeTypes:
uniqueItems: true
type: array
items:
type: string
nullable: true
contractors:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/ContractorData'
nullable: true
uniqueContractors:
type: integer
format: int32
readOnly: true
factoringAmt:
type: array
items:
type: number
format: double
nullable: true
factoringN:
type: array
items:
type: integer
format: int32
nullable: true
invoicesAmt:
type: array
items:
type: number
format: double
nullable: true
invoicesN:
type: array
items:
type: integer
format: int32
nullable: true
500+Amt:
type: array
items:
type: number
format: double
nullable: true
500+N:
type: array
items:
type: integer
format: int32
nullable: true
colAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
disbAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
extAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
gamblingAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
incomeAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
inflow:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
inflowClearedAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
inflowClearedN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
outflow:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
pmtAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
debtAmt:
type: array
items:
type: number
format: double
nullable: true
debtN:
type: array
items:
type: number
format: double
nullable: true
socialAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
taxAmt:
type: array
items:
type: number
format: double
nullable: true
readOnly: true
newAccounts:
type: integer
format: int32
readOnly: true
colN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
disbN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
extN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
alimonyAmt:
type: array
items:
type: number
format: double
nullable: true
alimonyN:
type: array
items:
type: integer
format: int32
nullable: true
gamblingN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
incomeN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
pmtN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
socialN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
taxN:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
verif:
type: array
items:
type: integer
format: int32
nullable: true
readOnly: true
averageInflowCleared:
type: number
format: double
readOnly: true
averageCollectionAmount:
type: number
format: double
readOnly: true
averageInflowClearedBalancePercent:
type: number
format: double
nullable: true
readOnly: true
additionalProperties: false
ScreenScrapeType:
enum:
- None
- Kontomatik
- BlueMedia
- Instantor
- BlueTransfer
- TransactionLink
type: string
successProcessingEnum:
enum:
- ok
- noClientMatched
- noDataFound
- ownDataOnly
type: string
SummaryCodeEnum:
enum:
- IB1
- IB0
- IT6
- IT5
- IT4
- IT3
- IT2
- IT1
- IT0
- ID1
- ID0
- IA3
- IA2
- IA1
- IA0
- IZ2
- IZ1
- IZ0
- IP3
- IP2
- IP1
- IP0
- IM6
- IM5
- IM4
- IM3
- IM2
- IM1
- IM0
type: string
SummaryGradeEnum:
enum:
- Niska
- Średnia
- Dobra
type: string
SummaryItem:
type: object
properties:
code:
$ref: '#/components/schemas/SummaryCodeEnum'
grade:
$ref: '#/components/schemas/SummaryGradeEnum'
description:
type: string
nullable: true
indicator:
type: string
nullable: true
recommendation:
type: array
items:
$ref: '#/components/schemas/Recommendation'
nullable: true
output:
nullable: true
additionalProperties: false
TrafficLight:
enum:
- RED
- YELLOW
- GREEN
type: string
TypWektorStatusuPlatnosci:
type: object
properties:
numertransakcjibik:
type: string
nullable: true
typtransakcji:
type: string
nullable: true
historiastatusuplatnosci:
type: string
nullable: true
additionalProperties: false
WeightedPeriod:
type: object
properties:
monthsAgo:
type: integer
format: int32
number:
type: number
format: double
additionalProperties: false
securitySchemes:
Bearer:
type: http
description: Please enter token
scheme: bearer
security:
- Bearer: [ ]
Updated 5 months ago