--- title: "Get credit requests by ID" method: GET path: "/credit-sessions/converted/{id}" --- # Get credit requests by ID `GET /credit-sessions/converted/{id}` ## Request - Base URL: `https://api.open-finance.ai/v3/loans` - URL: `https://api.open-finance.ai/v3/loans/credit-sessions/converted/{id}` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.open-finance.ai/oauth/token` scopes: `read:sessions` ## Path parameters - `id` string, required ## Response `200` Fetched successfully. The 'raw' field will be included only if the user has admin privileges. - object - `count` number: The number of items returned - `nextPage` string: URL for the next page if available - `items` CreditSession[]: Array of credit session items - `sessionId` string - `customerId` string - `advisorId` string - `orgId` string - `userId` string - `leadId` string - `opportunityId` string - `accountId` string - `redirectUrl` string: Only when get credit session - `contactId` string - `status` string - `leadConverted` boolean - `creditRequested` number - `creditTerm` string - `creditPurpose` string - `creditType` string - `collateralType` string - `firstName` string - `lastName` string - `title` string - `nationalId` string - `email` 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` RequiredFile[] - `fileName` string - `apiName` string - `label` object - `en` string - `he` string - `isRequired` boolean - `sessionOtherFiles` RecordedFile[] - `url` string: URL to access the file from S3 - `timestamp` number: Timestamp of the file - `fileName` string: Name of the file - `bucketPath` string: S3 bucket path where the file is stored - `bucketFileName` string: Name of the file in the S3 bucket - `processType` 'PCN' | '6111' | 'OSH': Type of process the file is associated with - `numberOfChildren` number - `countryOfCitizenship` string - `creditRepaymentSource` string - `seniorityPeriod` string - `selfEmployedDescription` string - `monthlyAvgIncomeRange` string - `isPropertyOwner` boolean - `housePaymentPerMonth` number - `loanPaymentPerMonth` number - `annualBusinessRevenue` string - `bankAccountSeniority` string - `advisorAgencyName` string - `isSeniorPublicOfficial` boolean - `isAuthorizedRepresentative` boolean - `isServiceRefusedForAMLorCTF` boolean - `isThirdPartyBeneficiary` boolean - `thirdPartyRelationshipDetails` string - `currentStep` string: The current step of the session - `isBusinessContinuation` boolean - `predecessorEntityId` string - `predecessorEntityTenureYears` integer - `raw` RawCreditSession[]: Array of raw credit session data. This field is returned only for admin users. - `PK` string: Primary key of the session - `SK` string: Sort key of the session - `orgId` string: Organization ID - `userId` string: User ID associated with the session - `sessionId` string: Unique session ID - `journeyId` string: ID of the journey associated with the session - `journeyUrl` string: URL of the journey associated with the session - `advisorId` string: Advisor ID associated with the session - `customerId` string: Customer ID associated with the session - `geoId` string: Geographical ID - `partnerId` string: Partner ID associated with the session - `agentId` string: Agent ID associated with the session - `sessionTransactionDestination` string: Transaction destination for the session - `sessionIsConverted` boolean: Indicates if the session was converted - `sessionIsAborted` boolean: Indicates if the session was aborted - `sessionIsEnded` boolean: Indicates if the session has ended - `sessionLeadSource` string: Lead source for the session - `sessionStatus` string: Status of the session - `loanerType` 'Private' | 'Business': Type of loaner - `sessionCurrency` string: Currency for the session - `sessionCreditRequested` number: Amount of credit requested in the session - `sessionApprovedAmount` integer: Approved loan amount after underwriting (may be lower than requested on partial approval) - `sessionCreditTerm` number: Credit term in months - `sessionCreditPurpose` string: Purpose of the credit - `sessionOtherCreditPurpose` string: Other specified credit purpose - `sessionCreditType` string: Type of credit - `sessionCollateralType` string: Type of collateral - `sessionCollateralAmount` number: Amount of collateral - `sessionCollateralFeeAmount` number: Fee amount for the collateral - `sessionLoanType` string: Type of loan - `sessionLoanTrack` string: Loan track - `sessionLoanInterest` number: Interest rate of the loan - `sessionLoanPaymentPerMonth` number: Monthly loan payment - `sessionStartDate` string, date: Start date of the session - `sessionEndDate` string, date: End date of the session - `sessionIsNewVehicle` boolean: Indicates if the session is for a new vehicle - `sessionCarType` string: Type of car - `sessionVehicleBrand` string: Brand of the vehicle - `sessionVehicleModel` string: Model of the vehicle - `sessionVehicleModelYear` string: Year of the vehicle model - `sessionVehicleLicensePlateNumber` string: License plate number of the vehicle - `sessionVehicleWorth` number: Worth of the vehicle - `sessionFirstName` string: First name of the customer in the session - `sessionLastName` string: Last name of the customer in the session - `sessionTitle` string: Title of the customer in the session - `sessionNationalId` string: National ID of the customer in the session - `sessionNationalIdIssueDate` string, date: Issue date of the national ID - `sessionNationalIdExpiryDate` string, date: Expiry date of the national ID - `sessionDateOfBirth` string, date: Date of birth of the customer - `sessionGender` 'Male' | 'Female' | 'Other': Gender of the customer - `sessionEmail` string: Email of the customer - `sessionPhone` string: Phone number of the customer - `sessionPhoneAtHome` string: Home phone number of the customer - `sessionPhoneAtWork` string: Work phone number of the customer - `sessionHasSignificantOther` boolean: Indicates if the customer has a significant other - `sessionHasPartner` boolean: Indicates if the customer has a partner - `sessionHasAgent` boolean: Indicates if the customer has an agent - `sessionMaritalStatus` 'Single' | 'Married' | 'Widowed' | 'Divorced' | 'SingleParent': Marital status of the customer - `sessionCityName` string: City name for the session - `sessionCityNumber` number: City number for the session - `sessionStreetName` string: Street name for the session - `sessionStreetNumber` number: Street number for the session - `sessionHouseNumber` number: House number for the session - `sessionApartmentNumber` number: Apartment number for the session - `sessionPostOfficeBox` number: Post office box number for the session - `sessionZipCode` number: Zip code for the session - `sessionGeoLocationScore` number: Geo-location score - `sessionGeoLocationCrime` number: Geo-location crime score - `customerCityName` string: Customer city name - `customerCityNumber` number: Customer city number - `customerStreetName` string: Customer street name - `customerStreetNumber` number: Customer street number - `customerHouseNumber` number: Customer house number - `customerApartmentNumber` number: Customer apartment number - `customerPostOfficeBox` number: Customer post office box number - `customerZipCode` number: Customer zip code - `contactCityName` string: Contact city name - `contactCityNumber` number: Contact city number - `contactStreetName` string: Contact street name - `contactStreetNumber` number: Contact street number - `contactHouseNumber` number: Contact house number - `contactApartmentNumber` number: Contact apartment number - `contactPostOfficeBox` number: Contact post office box number - `contactZipCode` number: Contact zip code - `propertyCityName` string: Property city name - `propertyCityNumber` number: Property city number - `propertyStreetName` string: Property street name - `propertyStreetNumber` number: Property street number - `propertyHouseNumber` number: Property house number - `propertyApartmentNumber` number: Property apartment number - `propertyPostOfficeBox` number: Property post office box number - `propertyZipCode` number: Property zip code - `propertyOwnerName` string: Property owner name - `propertyOwnerNationalId` string: Property owner national ID - `propertyOwnerEmail` string: Property owner email - `propertyOwnerPhoneNumber` string: Property owner phone number - `sessionBankName` string: Bank name for the session - `sessionBankCode` string: Bank code for the session - `sessionBankBranchName` string: Bank branch name for the session - `sessionBankBranchCode` string: Bank branch code for the session - `sessionBankAccountNumber` string: Bank account number for the session - `sessionBankAccountOwnerName` string: Bank account owner name - `sessionBusinessId` string: Business ID for the session - `sessionBusinessName` string: Business name for the session - `sessionBusinessType` string: Type of business for the session - `sessionBusinessEstablishedDate` string: Established date of the business for the session - `sessionBusinessPhoneNumber` string: Phone number of the business - `sessionBusinessNumberOfCustumers` number: Number of customers for the business - `sessionBusinessNumberOfEmployees` number: Number of employees in the business - `sessionBusinessNumberOfOwners` number: Number of owners of the business - `sessionWebsiteUrl` string: Website URL of the business - `sessionActivityArea` string: Activity area of the session - `sessionGeoArea` string: Geo area of the session - `sessionEmploymentStatus` string: Employment status of the customer in the session - `sessionOccupationType` string: Occupation type of the customer - `sessionYearsOfSeniority` number: Years of seniority for the customer in the session - `sessionIncomeFromLastFinancialStatement` number: Income from the last financial statement - `sessionAverageIncome` number: Average income for the session - `sessionLastYearRevenue` number: Revenue from the last year - `sessionCurrentYearAnnualIncome` number: Current year's annual income - `sessionPreviousYearAnnualIncome` number: Previous year's annual income - `sessionMonthlyAvgIncome` number: Monthly average income - `sessionMonthlyGrossIncome` number: Monthly gross income - `sessionMonthlyNetIncome` number: Monthly net income - `sessionMonthlyIncomeNetPrivate` number: Monthly net private income - `sessionTotalMonthlyIncomeAmount` number: Total monthly income amount - `sessionIsAdditionalIncome` boolean: Indicates if there is additional income - `sessionAdditionalIncomeAmount` number: Amount of additional income - `sessionAdditionalIncomeSource` string: Source of additional income - `sessionIsAdditionalSavingsAccount` boolean: Indicates if there is an additional savings account - `sessionIsAdditionalSavingsAccountWorth` number: Worth of additional savings account - `sessionMonthlyMortgagePayment` number: Monthly mortgage payment - `sessionMonthlyLoansPaymentTotalAmount` number: Total monthly loan payments - `sessionOtherLoansPaymentTotalAmount` number: Total payment of other loans - `sessionHasFailedCheques` boolean: Indicates if there are failed cheques - `sessionIsRealEstateOwner` boolean: Indicates if the customer owns real estate - `sessionIsSeniorPublicOffice` boolean: Indicates if the customer holds a senior public office - `sessionIsBankrupt` boolean: Indicates if the customer is bankrupt - `sessionIsExpatriate` boolean: Indicates if the customer is an expatriate - `sessionIsLawsuit` boolean: Indicates if the customer is involved in a lawsuit - `sessionIsForThirdParty` boolean: Indicates if the session is for a third party - `sessionIsPreviouslyRefusedCredit` boolean: Indicates if the customer has been previously refused credit - `sessionIsCreditOrFinancialService` boolean: Indicates if the session is related to credit or financial services - `sessionIsSelfEmployed` boolean: Indicates if the customer is self-employed - `sessionIsHelpByOther` boolean: Indicates if the customer is helped by others - `sessionReqFiles` RequiredDocObject[] - `apiName` string - `fileName` string - `label` object - `he` string - `en` string - `isRequired` boolean - `sessionOtherFiles` OtherDocRecorded[] - `timestamp` number: Timestamp of when the document was recorded - `fileName` string: Name of the file - `bucketPath` string: S3 bucket path where the file is stored - `bucketFileName` string: Name of the file in the S3 bucket - `processType` 'PCN' | '6111' | 'OSH' | 'ESSNA': Type of process the file is associated with - `url` string: URL to access the file - `sessionCreditInfoHasUserConsented` boolean: Indicates if the user has consented to credit information - `sessionCreditInfoConsentDate` string, date: The date when the user consented to credit information - `sessionCreditInfoConsentDateApprovedDeal` string, date: The date when the credit deal was approved - `sessionCurrentStep` string: The current step of the session - `sessionApproveMailingList` boolean: Indicates if the user has approved being added to a mailing list - `sessionMailingListConsented` boolean: Indicates if the user has consented to being part of the mailing list - `sessionSalesManager` string: The name of the sales manager responsible for the session - `sessionContactRole` string: Role of the contact in the session - `sessionPartnerName` string: Name of the session partner - `sessionPartnerPhoneNumber` string: Phone number of the session partner - `sessionOtherCollateral` string: Details about other collateral in the session - `sessionProposalCollateralType` string: Type of collateral proposed in the session - `sessionCommiteeDesc` string: Description of the committee's decision in the session - `sessionJ5Url` string: J5 URL for the session - `sessionJ5PrivateKey` string: J5 private key for the session - `sessionJ5ReceiptNumber` string: J5 receipt number - `sessionJ5TokenNumber` string: J5 token number - `sessionJ5FinalizedRedirectUrl` string: Finalized redirect URL for J5 session - `sessionJ5Message` string: Message for the J5 session - `sessionJ5ResponseCode` string: Response code for the J5 session - `sessionConnectionMode` string: Connection mode for the session - `sessionIframe` boolean: Indicates if the session is using an iframe - `sessionRefreshData` boolean: Indicates if data should be refreshed for the session - `sessionIncludeFakeProviders` boolean: Indicates if fake providers are included in the session - `sessionAllowedProviderIds` string[]: Array of allowed provider IDs for the session - `sessionExpiryDate` string, date-time: The expiry date of the session - `sessionPsuId` string: PSU ID for the session - `sessionBdiCreditStatus` string: BDI credit status for the session - `sessionBdiReasonForRejection` string: Reason for BDI credit rejection - `customerDhDecision` DBDataHarborBusinessKeys - `dhCompFinalGroup` string - `dhCompFinalScore` string - `dhCompGO` string - `dhDB10IncomeGrowth` string - `dhDB11RelatedCompanies` string - `dhDB12Properties` string - `dhDB1LegalStatus` string - `dhDB2EconomyBranch` string - `dhDB3Seniority` string - `dhDB4Alerts` string - `dhDB5RelatedCompanyAlerts` string - `dhDB6SuppliersReports` string - `contactDhDecision` DBDataHarborPrivateKeys - `dhArrearsDefault` string - `dhDecision` string - `dhDefaultBankruptcyLast3Years` string - `dhDefaultBouncedCheckPrivet` string - `dhDefaultDebtForgivenes` string - `dhDefaultExecutionProceedingandQ7FInal` string - `dhDefaultLimitedFinancialfinal` string - `dhDefaultRestrictedAccountlast3Years` string - `dhFinalOsekScore` string - `dhFinalPrivetScore` string - `dhLegalProcedureDefaultFinalPrivet` string - `dhLessThen3MonthHistory` string - `dhNOGODBScoreFinal` string - `dhNOGOArrearsBussinesFinal` string - `dhNOGOBankruptcyLast3Years` string - `dhNOGOCrediC` string - `dhNOGODebtForgivenesBusiness` string - `dhNOGODebtForgivenesPrivet` string - `dhNOGODebtRestructuringBusiness` string - `dhNOGODebtRestructuringPrivet` string - `dhNOGOExecutionProceedingFInalBussines` string - `dhNOGOExecutionProceedingPrivetFinal` string - `dhNOGOLegalProcedureBussinesFinal` string - `dhNOGOLegalProcedurePrivetFinal` string - `dhNOGOLessThan3monthshist` string - `dhNOGOLimitedFinancialfinal` string - `dhNOGORestrictedAccountlast3Years` string - `dhNOGOp` string - `dhNoGoArrearsPrivetFinal` string - `dhNogoAge` string - `dhNogoAgeandNoHistoryBussinesFinal` string - `dhNogoSocioeconomic` string - `dhOsekQ11Desc` string - `dhOsekQ11` string - `dhOsekQ13Desc` string - `dhOsekQ13` string - `dhOsekQ14Desc` string - `dhOsekQ14` string - `dhOsekQ15Desc` string - `dhOsekQ15` string - `dhOsekQ16Desc` string - `dhOsekQ16` string - `dhOsekQ1Desc` string - `dhOsekQ1` string - `dhOsekQ3Desc` string - `dhOsekQ3` string - `dhOsekQ4Desc` string - `dhOsekQ4` string - `dhOsekQ5Desc` string - `dhOsekQ5` string - `dhOsekQ6Desc` string - `dhOsekQ6` string - `dhOsekQ7Desc` string - `dhOsekQ7` string - `dhOsekQ9Desc` string - `dhOsekQ9` string - `dhPeriodDate` string - `dhPrivetQ10Desc` string - `dhPrivetQ10` string - `dhPrivetQ11Desc` string - `dhPrivetQ11` string - `dhPrivetQ12Desc` string - `dhPrivetQ12` string - `dhPrivetQ13Desc` string - `dhPrivetQ13` string - `dhPrivetQ14Desc` string - `dhPrivetQ14` string - `dhPrivetQ1Desc` string - `dhPrivetQ1` string - `dhPrivetQ2Desc` string - `dhPrivetQ2` string - `dhPrivetQ3Desc` string - `dhPrivetQ3` string - `dhPrivetQ4Desc` string - `dhPrivetQ4` string - `dhPrivetQ5Desc` string - `dhPrivetQ5` string - `dhPrivetQ6Desc` string - `dhPrivetQ6` string - `dhPrivetQ7Desc` string - `dhPrivetQ7` string - `dhPrivetQ8Desc` string - `dhPrivetQ8` string - `dhPrivetQ9Desc` string - `dhPrivetQ9` string - `createdAt` string, date-time: Timestamp when the session was created - `updatedAt` string, date-time: Timestamp when the session was last updated - `sessionNumberOfChildren` number: Number of children of the customer - `sessionCountryOfCitizenship` string: Country of citizenship of the customer - `sessionCreditRepaymentSource` string: Source of credit repayment - `sessionSeniorityPeriod` string: Seniority period - `sessionSelfEmployedDescription` string: Description for self-employed customers - `sessionMonthlyAvgIncomeRange` string: Monthly average income range - `sessionIsPropertyOwner` boolean: Indicates if the customer is a property owner - `sessionHousePaymentPerMonth` number: Monthly house payment amount - `sessionAnnualBusinessRevenue` string: Annual business revenue - `sessionBankAccountSeniority` string: Bank account seniority period - `sessionIsSeniorPublicOfficial` boolean: Indicates if the customer is a senior public official - `sessionIsAuthorizedRepresentative` boolean: Indicates if the customer is an authorized representative - `sessionIsServiceRefusedForAMLorCTF` boolean: Indicates if service was refused for AML or CTF reasons - `sessionIsThirdPartyBeneficiary` boolean: Indicates if there is a third party beneficiary - `sessionThirdPartyRelationshipDetails` string: Details about third party relationship - `sessionBdiReportError` string: Error message from BDI report ## Other responses - `400`: Bad Request - `403`: Forbidden - `500`: Internal server error --- [API](https://skmtc.dev/open-finance/apis/loans.md) - [All operations](https://skmtc.dev/open-finance/apis/loans/llms.txt) - [OpenAPI document](https://skmtc.dev/open-finance/apis/loans/revisions/915c69e62042?raw)