Create a credit request

post

https://{API_PREFIX}.open-finance.ai/v3/loans/credit-sessions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sessionId

string

customerId

string

advisorId

string

orgId

string

userId

string

leadId

string

opportunityId

string

accountId

string

connectionRedirectUrl

string

contactId

string

status

string

leadConverted

boolean

creditRequested

number

creditTerm

string

creditPurpose

string

creditType

string

collateralType

string

firstName

string

lastName

string

title

string

nationalId

string

phoneNumber

string

dateOfBirth

string

address

string

employmentStatus

string

occupationType

string

businessId

string

businessName

string

businessPhoneNumber

string

businessType

string

businessEstablishedDate

string

activityArea

string

geoArea

string

lastYearRevenue

number

averageIncome

number

monthlyGrossIncome

number

monthlyNetIncome

number

isAdditionalIncome

boolean

additionalIncomeAmount

number

hasFailedCheques

boolean

isBankrupt

boolean

isSeniorPublicOffice

boolean

isExpatriate

boolean

isPreviouslyRefusedCredit

boolean

isCreditOrFinancialService

boolean

isHelpByOther

boolean

approveMailingList

boolean

bankName

string

bankNumber

string

bankBranchName

string

bankBranchNumber

string

bankAccountNumber

string

bankAccountOwnerName

string

creditInfoHasUserConsented

boolean

creditInfoConsentDate

string

creditInfoConsentDateApprovedDeal

string

salesManager

string

contactRole

string

partnerName

string

partnerPhoneNumber

string

otherCollateral

string

proposalCollateralType

string

commiteeDesc

string

createdDate

string

sessionReqFiles

array of objects

sessionReqFiles

sessionOtherFiles

array of objects

sessionOtherFiles

numberOfChildren

number

countryOfCitizenship

string

creditRepaymentSource

string

seniorityPeriod

string

selfEmployedDescription

string

monthlyAvgIncomeRange

string

isPropertyOwner

boolean

housePaymentPerMonth

number

loanPaymentPerMonth

number

annualBusinessRevenue

string

bankAccountSeniority

string

isSeniorPublicOfficial

boolean

isAuthorizedRepresentative

boolean

isServiceRefusedForAMLorCTF

boolean

isThirdPartyBeneficiary

boolean

thirdPartyRelationshipDetails

string

bdiReportError

string

Error message from BDI report

isBusinessContinuation

boolean

predecessorEntityId

string

predecessorEntityTenureYears

integer

iframe

boolean

leadSource

string

leadConversion

boolean

withJourneyUrl

boolean

journeySettings

object

includeFakeProviders

boolean

allowedProviderIds

array of strings

allowedProviderIds

refreshData

boolean

expiryDate

string

agentEmail

string

connectionMode

string

psuId

string

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

400Bad Request

403Forbidden

500Internal server error