---
title: "Create a credit request"
method: POST
path: "/credit-sessions"
---

# Create a credit request

`POST /credit-sessions`

## Request body

- object
  - `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
  - `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
  - `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
    - `journeyId` string
    - `needsOTP` boolean
  - `includeFakeProviders` boolean
  - `allowedProviderIds` string[]
  - `refreshData` boolean
  - `expiryDate` string
  - `agentEmail` string
  - `connectionMode` string
  - `psuId` string

## Response `201`

Created

- object
  - `sessionId` string
  - `customerId` string
  - `leadId` string
  - `opportunityId` string
  - `accountId` string
  - `contactId` string
  - `id` string
  - `connectUrl` string

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal server error

---

[API](https://skmtc.net/open-finance/apis/auth.md) · [All operations](https://skmtc.net/open-finance/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open-finance/auth/versions/b4d401b65c3d/schema)